Skip to content

Commit

Permalink
better description of iidda.api
Browse files Browse the repository at this point in the history
  • Loading branch information
stevencarlislewalker committed Feb 26, 2024
1 parent 839d74c commit 03ba368
Showing 1 changed file with 7 additions and 13 deletions.
20 changes: 7 additions & 13 deletions R/iidda.api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,15 @@
[![R-CMD-check](https://github.com/stevencarlislewalker/iidda-tools/actions/workflows/R-CMD-check-iidda.api.yaml/badge.svg)](https://github.com/stevencarlislewalker/iidda-tools/actions/workflows/R-CMD-check-iidda.api.yaml)
<!-- badges: end -->

Quick install:

## `iidda.api`

The `iidda.api` package is an R binding to the [iidda_api](../python/README.md). These bindings are for developers building R packages and Shiny Apps on top of IIDDA. Currently `iidda.analysis` and `iidda.shiny` both depend on `iidda.api`.

### Installation

This `iidda.api` package depends on our specific [fork](https://github.com/canmod/rapiclient/) of [`rapiclient`](https://github.com/bergant/rapiclient).
```
remotes::install_github('canmod/rapiclient')
```
The `iidda.api` package is used to get data from the International Infectious Disease Data Archive (IIDDA), and can be installed with the following R command.

Once this dependency and [others](iidda.api/DESCRIPTION) are installed, you can install the package itself using this command.
```
remotes::install_github('canmod/iidda-tools', subdir = 'R/iidda.api')
install.packages("iidda.api"
, repos = c(
"https://canmod.r-universe.dev"
, "https://cran.r-project.org"
)
)
```

0 comments on commit 03ba368

Please sign in to comment.