Skip to content

Commit

Permalink
Update pkgdown and description (move names etc.)
Browse files Browse the repository at this point in the history
  • Loading branch information
TreyBilling committed Dec 17, 2024
1 parent 7eb88d9 commit 07ffbb8
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 41 deletions.
10 changes: 5 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ Type: Package
Title: Manipulate 'ACLED' Data
Version: 0.1.0
Authors@R: c(
person(given = "",
family = "ACLED",
role = c("cph", "cre"),
email ="[email protected]"),
person(given = "Lucas",
family = "Fagliano",
role = "aut",
Expand All @@ -22,11 +26,7 @@ Authors@R: c(
person(given = "Michael",
family = "Start",
role = "aut",
email = "[email protected]"),
person(given = "",
family = "ACLED",
role = c("cph", "cre"),
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
Expand Down
39 changes: 4 additions & 35 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ knitr::opts_chunk$set(
[![codecov](https://codecov.io/gh/ACLED/acledR/graph/badge.svg?token=TDJodXhEvx)](https://codecov.io/gh/ACLED/acledR)
<!-- badges: end -->

Welcome to ACLED's official R package! With this package we want to bring you an even more convenient way to access ACLED data, building on top of our existing API.

In this repo you can find the source code of the package, as well as the documentation. You can also visit https://acled.github.io/acledR/ for more information and walkthroughs on how to use the package.
Welcome to ACLED's official R package! This package simplifies access to the data via ACLED's API. It also provides convenient functions for making common ACLED data transformations. See dtacled.github.io/acledR for more information and tutorials on how to use the package.


# Overview
Expand All @@ -34,41 +32,12 @@ To access ACLED data, please register an account at [developer.acleddata.com](de
* You can visit our [guide](https://acleddata.com/acleddatanew//wp-content/uploads/2021/11/ACLED_Access-Guide_October-2020.pdf) on how to easily set up your ACLED account.
* We recommend you to save your ACLED API Key in an R object so you can easily re-use your key.

## Installation (for private repo)

Since the package repo is currently private, you need to tell R and Github that you're a collaborator. To do so, you first create a Github personal access token (PAT). You can set this to expire after a certain time (the default) or be permanent. We can initiate this process internally via:

```{r, eval=F}
# install.packages("usethis") if not installed already
# create personal access token - this should redirect to your github page where you can copy the token
usethis::create_github_token()
```

After you've copied the PAT from the browser and saved it somewhere safe, return to R and run this, which will store the PAT locally.

```{r, eval=F}
# paste the token where it says YourPAT
credentials::set_github_pat("YourPAT")
# if you run this, it should print your token; if not we've failed
Sys.getenv("GITHUB_PAT")
```

Now you can install the package and it will automatically locate your PAT.

```{r, eval=F}
# install from github
devtools::install_github("ACLED/acledR")
```

## Installation

## Installation (for public use)
The package will be reviewed and available on CRAN shortly. In the meantime, you can install the package from Github:

The package is on the process to get submited to the Comprehensive R Archive Network (CRAN). In the meantime, you can install the package from Github.
```{r, eval = F}
devtools::install_github("ACLED/acledR") ## if you are interested in a particular branch, please add a 'ref' argument.
devtools::install_github("ACLED/acledR")
```

Once the package is uploaded to CRAN, you can install it with the following command:
```{r, eval = F}
install.packages("acledR")
```
2 changes: 1 addition & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
url: https://dtacled.github.io/acledR/
template:
bootstrap: 5
bootswatch: zephyr
# bootswatch: zephyr
navbar:
title: acledR
left:
Expand Down

0 comments on commit 07ffbb8

Please sign in to comment.