Skip to content

Commit

Permalink
Merge pull request #69 from FvD/T68
Browse files Browse the repository at this point in the history 
Fix issues for publication to CRAN
  • Loading branch information
@ronnyhdez
ronnyhdez authored May 24, 2022
2 parents 21bec36 + a73355b commit c16f5bb
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 57 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
View file
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.4
Version: 1.0.5
Authors@R: c(
person(given = "ixpantia,
family = SRL",
Expand All @@ -22,7 +22,7 @@ URL: https://ixpantia.github.io/lacrmr/
BugReports: https://github.com/ixpantia/lacrmr/issues
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.1.2
RoxygenNote: 7.2.0
Depends:
R (>= 3.6),
magrittr
Expand Down
6 changes: 3 additions & 3 deletions README.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ devtools::install_github("ixpantia/lacrmr")
## Credentials:

At first you will need to obtain your [user code and API
token](https://www.lessannoyingcrm.com/app/Settings/Api) from your Less
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!

Expand All @@ -65,7 +65,7 @@ not leave your credentials in your code, check the package vignette!

## Usage

```{r, include = FALSE}
```{r, eval = FALSE}
library(lacrmr)
library(mockery)
pipeline_data <- system.file("testdata/pipeline_test_data.json",
Expand All @@ -77,7 +77,7 @@ stub(where = get_pipeline_report,
how = pipeline_data)
```

```{r}
```{r, eval=FALSE}
# Load the lacrmr package in your session
library(lacrmr)
Expand Down
80 changes: 28 additions & 52 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# lacrmr <a><img src="man/figures/lacrmR.png" align="right" width="30%"></a>
# lacrmr <a href="url"><img src="man/figures/lacrmR.png" align="right" width="30%"></a>

<!-- badges: start -->

Expand All @@ -16,24 +16,23 @@ your goals, create reports and automate your workflow.
## Overview

If you have a business or an organization that uses [Less Annoying
CRM](https://account.lessannoyingcrm.com/invite/51B03)* 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. [* *note that this is a referral URL, it will give you
and us one additional month free if you use it*].
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. |
| 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 @@ -48,16 +47,28 @@ devtools::install_github("ixpantia/lacrmr")
## Credentials:

At first you will need to obtain your [user code and API
token](https://www.lessannoyingcrm.com/app/Settings/Api) 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\!
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!

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\!
vignette!

## Usage

``` r
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
# Load the lacrmr package in your session
library(lacrmr)
Expand All @@ -69,48 +80,13 @@ sales <- get_pipeline_report(user_code = "12454",

## Use glimpse function to check the data frame
dplyr::glimpse(sales)
#> Rows: 7
#> Columns: 33
#> $ result_contact_id <chr> "35041909076033466731615…
#> $ result_user_id <chr> "334595", "435944", "334…
#> $ result_company_id <lgl> NA, NA, NA, NA, NA, NA, …
#> $ result_background_info <chr> "", NA, "", NA, NA, NA, …
#> $ result_birthday <chr> NA, "", NA, "", "", "", …
#> $ result_is_company <chr> "1", "1", "1", "1", "1",…
#> $ result_company_name <chr> "Mambi business", "Mambi…
#> $ result_industry <chr> "", "Pets", "Education",…
#> $ result_num_employees <chr> "", "", "", "", "", "", …
#> $ result_creation_date <chr> "2018-02-26 21:02:38", "…
#> $ result_edited_date <chr> "2019-12-30 16:15:21", "…
#> $ result_original_google_id <lgl> NA, NA, NA, NA, NA, NA, …
#> $ result_employer_name <lgl> NA, NA, NA, NA, NA, NA, …
#> $ result_company_employees <lgl> NA, NA, NA, NA, NA, NA, …
#> $ result_pipeline_id <chr> "35049658326669756459004…
#> $ result_status_id <chr> "35058957116029205737561…
#> $ result_priority <chr> "3", "2", "2", "2", "2",…
#> $ result_last_note <chr> "20191217 - mambi propon…
#> $ result_start_date <chr> "2019-12-18 09:11:35", "…
#> $ result_last_update <chr> "2019-12-18 09:12:05", "…
#> $ result_num_updates <chr> "2", "4", "14", "1", "14…
#> $ result_start_status_id <chr> "35058957116029205737561…
#> $ result_last_updated_by <chr> "334595", "435944", "435…
#> $ result_sort_order <chr> "0", "2", "2", "2", "2",…
#> $ result_show_in_reports <chr> "1", "1", "1", "1", "1",…
#> $ result_custom_opportunity_data_new <chr> "{\"35729357277614122524…
#> $ result_custom_contact_data_new <chr> "{\"35729357275677214396…
#> $ result_pipeline_item_id <chr> "36355809253925838301030…
#> $ result_status_name <chr> "Identificado", "Contact…
#> $ success <lgl> TRUE, TRUE, TRUE, TRUE, …
#> $ result_custom_fields_priority <chr> "High Priority", "Medium…
#> $ result_custom_fields_descripcion_oportunidad <chr> "Oportunidades de colabo…
#> $ result_custom_fields_valor <chr> "4000", "", "8000", "", …
```

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\!
Have fun analyzing your customer relationship data!

## Getting help

Expand Down
1 change: 1 addition & 0 deletions lacrmr.Rproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@ StripTrailingWhitespace: Yes

BuildType: Package
PackageUseDevtools: Yes
PackageCleanBeforeInstall: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
PackageRoxygenize: rd,collate,namespace

0 comments on commit c16f5bb

Please sign in to comment.