Merge pull request #38 from dtacled/tb

Pre cran small tweaks

.Rbuildignore

@@ -20,3 +20,4 @@ acled_generate_counts.R
 acled_generate_movers.R
 acled_report_api.R
 acled_actor_concentration.R
+^cran-comments\.md$

DESCRIPTION

@@ -1,13 +1,13 @@
 Package: acledR
 Type: Package
-Title: Manipulate 'ACLED' Data
+Title: Manipulate ACLED Data
 Version: 0.1.0
 Authors@R: c(
     person(given = "",
            family = "ACLED", 
            role = c("cph", "cre"), 
            email ="[email protected]"))
-Description: The package allows users to easily interact with 'ACLED' data by providing wrappers for the API and other functions to manipulate 'ACLED' data. 
+Description: The official ACLED R package for extracting and manipulating ACLED data.
 License: GPL (>= 3)
 Encoding: UTF-8
 LazyData: true

NEWS.md

@@ -0,0 +1,3 @@
+# acledR 0.1.0
+
+* Initial CRAN submission.

R/acled_access.R

@@ -4,6 +4,7 @@
 #' @param email This is the email that you register in the ACLED Access portal (https://developer.acleddata.com/)
 #' @param key This is the key generated by the ACLED Access portal.
 #' @family API and Access
+#' @returns Returns a success message if ACLED credentials are successfully authorized
 #' @examples
 #' \dontrun{
 #' acled_access(email = "your_email", key = "your_key")

R/acled_rounding.R

@@ -4,6 +4,7 @@
 #' @param num int. This is the number we are trying to round.
 #' @param digits int. Where do we want to round up. It accepts 0 (whole number), 1 (tenth place), 2 (hundredths), etc.
 #' @family Helpers
+#' @returns A rounded numeric value
 #' @details
 #' This function is meant to address the problem of rounding in R where the approach is always round to even. The function is meant to round things following the simple rule. If the decimal is 5+ then round up, if not round down. With the 'digits' argument, one can set up the specificity of the rounding, 0= whole number, 1 = tenth place, 2=hundreds place, and so on.
 #' @examples

README.Rmd

@@ -28,9 +28,11 @@ To access ACLED data, please register an account at [developer.acleddata.com](ht
 
 ## Installation
 
-The package will be reviewed and available on CRAN shortly. In the meantime, you can install the package from Github:
-
 ```{r, eval = F}
+# Install via cran
+install.packages("acledR")
+
+# Install development version from github
 devtools::install_github("ACLED/acledR")
 ```
 

cran-comments.md

@@ -0,0 +1,5 @@
+## R CMD check results
+
+0 errors | 0 warnings | 1 note
+
+* This is a new release.