Skip to content

Commit

Permalink
Merge pull request #88 from FvD/T86
Browse files Browse the repository at this point in the history
Prepara publicación
  • Loading branch information
FvD authored Oct 29, 2023
2 parents 22d66ec + 6ac56bf commit a299a51
Show file tree
Hide file tree
Showing 19 changed files with 770 additions and 1,196 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: lacrmr
Title: Connect to the 'Less Annoying CRM' API
Version: 1.0.6
Version: 1.1.1
Authors@R: c(
person(given = "ixpantia,
family = SRL",
Expand Down
49 changes: 17 additions & 32 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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}
123 changes: 39 additions & 84 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit a299a51

Please sign in to comment.