diff --git a/.Rbuildignore b/.Rbuildignore index ad352f1..22feb32 100755 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -20,3 +20,4 @@ acled_generate_counts.R acled_generate_movers.R acled_report_api.R acled_actor_concentration.R +^cran-comments\.md$ diff --git a/DESCRIPTION b/DESCRIPTION index 16f6ba8..28f5e59 100644 --- a/DESCRIPTION +++ b/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 ="data@acleddata.com")) -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 diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000..00cbc76 --- /dev/null +++ b/NEWS.md @@ -0,0 +1,3 @@ +# acledR 0.1.0 + +* Initial CRAN submission. diff --git a/R/acled_access.R b/R/acled_access.R index 647e959..a674713 100755 --- a/R/acled_access.R +++ b/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") diff --git a/R/acled_rounding.R b/R/acled_rounding.R index 0f498b4..3e13240 100755 --- a/R/acled_rounding.R +++ b/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 diff --git a/README.Rmd b/README.Rmd index e091713..20159a1 100755 --- a/README.Rmd +++ b/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") ``` diff --git a/cran-comments.md b/cran-comments.md new file mode 100644 index 0000000..858617d --- /dev/null +++ b/cran-comments.md @@ -0,0 +1,5 @@ +## R CMD check results + +0 errors | 0 warnings | 1 note + +* This is a new release.