-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prepara publicación
- Loading branch information
Showing
19 changed files
with
770 additions
and
1,196 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,36 +13,30 @@ knitr::opts_chunk$set( | |
) | ||
``` | ||
|
||
# lacrmr <a href="https://ixpantia.github.io/lacrmr/"><img src="man/figures/lacrmR.png" align="right" width="30%"></a> | ||
# lacrmr <a href="https://ixpantia.github.io/lacrmr/"><img src="man/figures/lacrmR.png" align="right" width="30%"/></a> | ||
|
||
<!-- badges: start --> | ||
|
||
[![CRAN status](https://www.r-pkg.org/badges/version/lacrmr)](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. | ||
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. | ||
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. | ||
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. | | ||
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 | ||
|
||
|
@@ -55,13 +49,9 @@ devtools::install_github("ixpantia/lacrmr") | |
|
||
## Credentials: | ||
|
||
At first you will need to obtain your [user code and API | ||
token](https://www.lessannoyingcrm.com/help/how-to-get-your-user-code-and-api-key) 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! | ||
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! | ||
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 | ||
|
||
|
@@ -90,15 +80,10 @@ sales <- get_pipeline_report(user_code = "12454", | |
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. | ||
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 [email protected] | ||
|
||
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} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.