Skip to content

Commit

Permalink
testing new workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
lfagliano committed Dec 1, 2023
1 parent 235eaf4 commit b395880
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ jobs:
extra-packages: any::pkgdown, local::.
needs: website

- name: load enviornment variables
run: |
echo "EMAIL_ADDRESS_EXAMPLES=${{ secrets.EMAIL_ADDRESS_EXAMPLES}}" >> .Renviron
echo "EXAMPLES_KEY=${{ secrets.EXAMPLES_KEY}}" >> .Renviron
- name: Build site
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
shell: Rscript {0}
Expand Down
8 changes: 7 additions & 1 deletion vignettes/get_started.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,16 @@ To be able to access the API, you require an API key. If you are not registered

Once you are registered, we encourage you to authenticate your credentials by using the `acled_access()` function. This function allows you to test that your credentials are working as intended and save your credentials in your R environment, thus allowing you to avoid the need to manually input your credentials during each data request.

```{r}
```{r, eval=FALSE}
acled_access(email = "[email protected]", key = "M3PWwg3DIdhHMuDiilp5") # This is an example, you will need to input your credentials.
```

```{r}
acled_access(email = Sys.getenv("EMAIL_ADDRESS_EXAMPLES"), key = ys.getenv("EXAMPLES_KEY"))
```



If the authentication was successful, you will find a message in the console stating "Authorization accepted".

## Requesting data from ACLED’s API - `acled_api()`
Expand Down

0 comments on commit b395880

Please sign in to comment.