README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/"
)
```

# 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 -->


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). 


## Installation

The package will be reviewed and available on CRAN shortly. In the meantime, you can install the package from Github:

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