-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.Rmd
89 lines (61 loc) · 3.83 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# lacrmr <a href="https://ixpantia.github.io/lacrmr/"><img src="man/figures/lacrmR.png" align="right" width="30%"/></a>
<!-- badges: start -->
[](https://cran.r-project.org/package=lacrmr)
<!-- badges: end -->
Get the information from your Less Annoying Customer Relationship Management API in a tidy data way. Useful for getting metrics, visualize your goals, create reports and automate your workflow.
## Overview
If you have a business or an organization that uses [Less Annoying CRM](https://www.lessannoyingcrm.com/) to manage contacts but also you are an R user, probably you will want to get your customer relationship data into R and do your own analysis or even to automate your monthly reports.
For this you will need to connect to the Less Annoying CRM API and deal with the json file to take it to a tidy format as a first step.
This package provides you with 4 functions that makes this process easier. These are and will return:
| Function | Return |
|-----------------------------|-----------------------------------------------------------------------------------------------------------------------|
| **get_pipeline_report()** | It will provide you with a dataframe containing the data corresponding to the pipeline that you need. |
| **get_account_information** | This will give you the information of your account. |
| **get_contact_information** | Information related to the contact you are searching for. |
| **search_contacts** | If you want to make sure a contact exists on your CRM, this function will return an statement confirming the contact. |
## Installation
Right now we have the development version. You can install lacrmr from Github:
```{r, eval = FALSE}
#install.packages("devtools")
devtools::install_github("ixpantia/lacrmr")
```
## Credentials:
At first you will need to obtain you user code and API token from your Less Annoying CRM. Once you have your credentials, you will be able to use the functions and take your lacrm data into R!
If you need advice on how to do this and also what are the best practices to not leave your credentials in your code, check the package vignette!
## Usage
```{r, eval = FALSE}
library(lacrmr)
library(mockery)
pipeline_data <- system.file("testdata/pipeline_test_data.json",
package = "lacrmr")
pipeline_data <- jsonlite::fromJSON(pipeline_data)
stub(where = get_pipeline_report,
what = "jsonlite::fromJSON",
how = pipeline_data)
```
```{r, eval=FALSE}
# Load the lacrmr package in your session
library(lacrmr)
## Get the data from a specific pipeline
sales <- get_pipeline_report(user_code = "12454",
api_token = "25632",
pipelineid = "458742fgg2544")
## Use glimpse function to check the data frame
dplyr::glimpse(sales)
```
Once you are done you will have a data frame with your customer relationship data. This will give you the opportunity to create your own visualizations or even your personalized dashboard.
Have fun analyzing your customer relationship data!
## Getting help
If you have problems using the functions or find a bug, please let us know with a minimal reproducible example on [github](https://github.com/ixpantia/lacrmr/issues) or send us an email to [hola\@ixpantia.com](mailto:[email protected]){.email}