Merge pull request #36 from dtacled/tb

Tb doc updates

DESCRIPTION

@@ -6,27 +6,7 @@ Authors@R: c(
     person(given = "",
            family = "ACLED", 
            role = c("cph", "cre"), 
-           email ="[email protected]"),
-    person(given = "Lucas", 
-	       family = "Fagliano",
-	       role = "aut", 
-	       email = "[email protected]"),
-    person(given = "Trey", 
-	       family = "Billing",
-	       role = "aut", 
-           email = "[email protected]"),
-    person(given = "Rachel", 
-           family = "Goodman", 
-           role = "aut", 
-           email = "[email protected]"),
-    person(given = "Katayoun", 
-           family = "Kishi", 
-           role = "aut", 
-           email = "[email protected]"),
-    person(given = "Michael", 
-           family = "Start", 
-           role = "aut", 
-           email = "[email protected]"))
+           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. 
 License: GPL (>= 3)
 Encoding: UTF-8

README.Rmd

@@ -12,7 +12,7 @@ knitr::opts_chunk$set(
 )
 ```
 
-# acledR <a href='ACLED.github.io/acledR/'><img src='man/figures/logo.png' align="right" height="139" /></a>
+# acledR | ACLED's official R package <a href='ACLED.github.io/acledR/'><img src='man/figures/logo.png' align="right" height="139" /></a>
 
 <!-- badges: start -->
 
@@ -21,8 +21,7 @@ knitr::opts_chunk$set(
 <!-- badges: end -->
 
 
-
-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). 
 

README.md

@@ -1,24 +1,25 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# acledR <a href='ACLED.github.io/acledR/'><img src='man/figures/logo.png' align="right" height="139" /></a>
+# acledR \| ACLED’s official R package <a href='ACLED.github.io/acledR/'><img src='man/figures/logo.png' align="right" height="139" /></a>
 
 <!-- badges: start -->
 
 [![R-CMD-check](https://github.com/ACLED/acledR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ACLED/acledR/actions/workflows/R-CMD-check.yaml)
 [![codecov](https://codecov.io/gh/ACLED/acledR/graph/badge.svg?token=TDJodXhEvx)](https://codecov.io/gh/ACLED/acledR)
 <!-- badges: end -->
 
-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).
 

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.
 

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: 
 

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 protected]", 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()`