diff --git a/DESCRIPTION b/DESCRIPTION index 6581673..16f6ba8 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -6,27 +6,7 @@ Authors@R: c( person(given = "", family = "ACLED", role = c("cph", "cre"), - email ="data@acleddata.com"), - person(given = "Lucas", - family = "Fagliano", - role = "aut", - email = "l.fagliano@acleddata.com"), - person(given = "Trey", - family = "Billing", - role = "aut", - email = "t.billing@acleddata.com"), - person(given = "Rachel", - family = "Goodman", - role = "aut", - email = "goodman.r@wustl.edu"), - person(given = "Katayoun", - family = "Kishi", - role = "aut", - email = "k.kishi@acleddata.com"), - person(given = "Michael", - family = "Start", - role = "aut", - email = "m.start@acleddata.com")) + 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. License: GPL (>= 3) Encoding: UTF-8 diff --git a/README.Rmd b/README.Rmd index 064fde5..e091713 100755 --- a/README.Rmd +++ b/README.Rmd @@ -12,7 +12,7 @@ knitr::opts_chunk$set( ) ``` -# acledR +# acledR | ACLED's official R package @@ -21,8 +21,7 @@ knitr::opts_chunk$set( - -Welcome to acledR! This package provides tools to extract and manipulate data from the [Armed Conflict Location and Event Data Project (ACLED)](https://acleddata.com/). It also provides convenient functions for making common ACLED data transformations. See [dtacled.github.io/acledR](https://dtacled.github.io/acledR) for more information and tutorials on how to use the package. +acledR is the official R package from the [Armed Conflict Location and Event Data Project (ACLED)](https://acleddata.com/), providing tools for extracting and manipulating ACLED data. The acledR [site](https://dtacled.github.io/acledR) hosts more information on how to use the package, including a general overview on the [Get Started](https://dtacled.github.io/acledR/articles/get_started.html) page. To access ACLED data, please register an account at [developer.acleddata.com](https://developer.acleddata.com). You can find detailed instructions for setting up your account and retrieving an API key [here](https://acleddata.com/acleddatanew//wp-content/uploads/2021/11/ACLED_Access-Guide_October-2020.pdf). diff --git a/README.md b/README.md index d6ca29b..47ea915 100755 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# acledR +# acledR \| ACLED’s official R package @@ -9,16 +9,17 @@ [![codecov](https://codecov.io/gh/ACLED/acledR/graph/badge.svg?token=TDJodXhEvx)](https://codecov.io/gh/ACLED/acledR) -Welcome to acledR! This package provides tools to extract and manipulate -data from the [Armed Conflict Location and Event Data Project -(ACLED)](https://acleddata.com/). It also provides convenient functions -for making common ACLED data transformations. See -[dtacled.github.io/acledR](https://dtacled.github.io/acledR) for more -information and tutorials on how to use the package. +acledR is the official R package from the [Armed Conflict Location and +Event Data Project (ACLED)](https://acleddata.com/), providing tools for +extracting and manipulating ACLED data. The acledR +[site](https://dtacled.github.io/acledR) hosts more information on how +to use the package, including a general overview on the [Get +Started](https://dtacled.github.io/acledR/articles/get_started.html) +page. To access ACLED data, please register an account at [developer.acleddata.com](https://developer.acleddata.com). You can find -detailed instructions for setting up your account and retreiving an API +detailed instructions for setting up your account and retrieving an API key [here](https://acleddata.com/acleddatanew//wp-content/uploads/2021/11/ACLED_Access-Guide_October-2020.pdf). diff --git a/man/acledR-package.Rd b/man/acledR-package.Rd index 9bb755a..1dfeece 100644 --- a/man/acledR-package.Rd +++ b/man/acledR-package.Rd @@ -23,14 +23,5 @@ Useful links: \author{ \strong{Maintainer}: ACLED \email{data@acleddata.com} [copyright holder] -Authors: -\itemize{ - \item Lucas Fagliano \email{l.fagliano@acleddata.com} - \item Trey Billing \email{t.billing@acleddata.com} - \item Rachel Goodman \email{goodman.r@wustl.edu} - \item Katayoun Kishi \email{k.kishi@acleddata.com} - \item Michael Start \email{m.start@acleddata.com} -} - } \keyword{internal} diff --git a/man/figures/logo.png b/man/figures/logo.png index 4cfa42e..e8b5707 100644 Binary files a/man/figures/logo.png and b/man/figures/logo.png differ diff --git a/vignettes/articles/acled_api.Rmd b/vignettes/articles/acled_api.Rmd index 3dd1ef6..5957d91 100644 --- a/vignettes/articles/acled_api.Rmd +++ b/vignettes/articles/acled_api.Rmd @@ -136,7 +136,7 @@ As is common when executing API calls, handling large volumes of data requires s - A question asking whether given this information and the number of available API calls linked to your account – you would like to proceed with your API call. -## Example - Gathering data with `acled_api()` +## Example - Requesting data with `acled_api()` Imagine you are interested in events from “Brazil” occurring between January 1st, 2022, and December 1st, 2022. diff --git a/vignettes/articles/acled_update.Rmd b/vignettes/articles/acled_update.Rmd index def6915..1440c90 100644 --- a/vignettes/articles/acled_update.Rmd +++ b/vignettes/articles/acled_update.Rmd @@ -16,7 +16,7 @@ options(warn = -1) ``` -ACLED’s is a ‘living dataset’, meaning the dataset is added to frequently and existing data can be updated. +ACLED is a ‘living dataset’ -- the dataset is added to frequently and existing data can be updated. The dataset changes in three ways: diff --git a/vignettes/get_started.Rmd b/vignettes/get_started.Rmd index f744f25..946b72c 100644 --- a/vignettes/get_started.Rmd +++ b/vignettes/get_started.Rmd @@ -20,7 +20,7 @@ library(acledR) library(dplyr) ``` -This vignette provides a brief overview of the `acledR` package. You can find more detailed explanations and examples under the 'Using acledR' tab. For general information on ACLED’s methodology, please visit [ACLED's Knowledge Base](https://acleddata.com/knowledge-base/). +This vignette provides a brief overview of the acledR package. You can find more detailed explanations and examples under the 'Using acledR' tab. For general information on ACLED’s methodology, please visit [ACLED's Knowledge Base](https://acleddata.com/knowledge-base/). The main objectives of this package are: @@ -40,7 +40,7 @@ You can begin by installing and then loading the package: # Install acledR install.packages("acledR") # from CRAN -devtools::install_github("ACLED/acledR") # or from the developer's branch from Github. +devtools::install_github("ACLED/acledR") # or from github. # Load acledR library(acledR) @@ -60,7 +60,7 @@ acled_access(email = "email@example.com", key = "your_key") # This is an exampl acled_access(email = Sys.getenv("EMAIL_ADDRESS_EXAMPLES"), key = Sys.getenv("EXAMPLES_KEY")) ``` -If the authentication was successful, you will find a message in the console stating "Authorization accepted". +If the authentication was successful, you will find a message in the console stating that your credentials were authorized. ## Requesting data from ACLED’s API - `acled_api()`