Skip to content

Commit 265fbe3

Browse files
committed
docs: render readme changes
1 parent fe34d29 commit 265fbe3

File tree

4 files changed

+36
-23
lines changed

4 files changed

+36
-23
lines changed

README.Rmd

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ ggplot2::theme_set(ggplot2::theme_bw())
2323
<!-- badges: end -->
2424

2525

26-
27-
The [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/) provides real-time access to epidemiological surveillance data for influenza, COVID-19, and other diseases for the USA at various geographical resolutions, both from official government sources such as the [Center for Disease Control (CDC)](https://www.cdc.gov/datastatistics/index.html) and [Google Trends](https://cmu-delphi.github.io/delphi-epidata/api/covidcast-signals/google-symptoms.html) and private partners such as [Facebook](https://delphi.cmu.edu/blog/2020/08/26/covid-19-symptom-surveys-through-facebook/) and [Change Healthcare](https://www.changehealthcare.com/). It is built and maintained by the Carnegie Mellon University [Delphi research group](https://delphi.cmu.edu/).
26+
The [Delphi Epidatr package](https://cmu-delphi.github.io/epidatr/) is an R front-end for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/), which provides real-time access to epidemiological surveillance data for influenza, COVID-19, and other diseases for the USA at various geographical resolutions, both from official government sources such as the [Center for Disease Control (CDC)](https://www.cdc.gov/datastatistics/index.html) and [Google Trends](https://cmu-delphi.github.io/delphi-epidata/api/covidcast-signals/google-symptoms.html) and private partners such as [Facebook](https://delphi.cmu.edu/blog/2020/08/26/covid-19-symptom-surveys-through-facebook/) and [Change Healthcare](https://www.changehealthcare.com/). It is built and maintained by the Carnegie Mellon University [Delphi research group](https://delphi.cmu.edu/).
2827

2928
This package is designed to streamline the downloading and usage of data from the [Delphi Epidata
3029
API](https://cmu-delphi.github.io/delphi-epidata/). It provides a simple R interface to the API, including functions for downloading data, parsing the results, and converting the data into a tidy format. The API stores a historical record of all data, including corrections and updates, which is particularly useful for accurately backtesting forecasting models. We also provide packages for downstream data processing ([epiprocess](https://github.com/cmu-delphi/epiprocess)) and modeling ([epipredict](https://github.com/cmu-delphi/epipredict)).
3130

3231
## Usage
32+
You can find detailed docs here:
3333

3434
```{r}
3535
library(epidatr)
@@ -62,16 +62,25 @@ ggplot(epidata, aes(x = time_value, y = value)) +
6262

6363

6464
## Installation
65+
You can install the stable version of this package from CRAN:
66+
67+
``` r
68+
```R
69+
install.packages("epidatr")
70+
pak::pkg_install("epidatr")
71+
renv::install("epidatr")
72+
```
73+
```
6574
66-
Install from GitHub:
75+
Or if you want the development version, install from GitHub:
6776
77+
```R
6878
```R
6979
# Install the dev version using `pak` or `remotes`
7080
pak::pkg_install("cmu-delphi/epidatr")
7181
remotes::install_github("cmu-delphi/epidatr")
7282
```
73-
74-
CRAN version coming soon.
83+
```
7584
7685
### API Keys
7786

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ Actions](https://github.com/cmu-delphi/epidatr/workflows/ci/badge.svg)](https://
1212
[![codecov](https://codecov.io/gh/dsweber2/epidatr/branch/dev/graph/badge.svg?token=jVHL9eHZNZ)](https://app.codecov.io/gh/dsweber2/epidatr)
1313
<!-- badges: end -->
1414

15-
The [Delphi Epidatr package](https://cmu-delphi.github.io/epidatr/) is
16-
an R frontend for the
17-
[Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/), which
18-
provides real-time access to epidemiological surveillance data for
19-
influenza, COVID-19, and other diseases for the USA at various
20-
geographical resolutions, both from official government sources such as
21-
the [Center for Disease Control
15+
The [Delphi Epidatr package](https://cmu-delphi.github.io/epidatr/) is
16+
an R front-end for the [Delphi Epidata
17+
API](https://cmu-delphi.github.io/delphi-epidata/), which provides
18+
real-time access to epidemiological surveillance data for influenza,
19+
COVID-19, and other diseases for the USA at various geographical
20+
resolutions, both from official government sources such as the [Center
21+
for Disease Control
2222
(CDC)](https://www.cdc.gov/datastatistics/index.html) and [Google
2323
Trends](https://cmu-delphi.github.io/delphi-epidata/api/covidcast-signals/google-symptoms.html)
2424
and private partners such as
@@ -39,8 +39,8 @@ processing ([epiprocess](https://github.com/cmu-delphi/epiprocess)) and
3939
modeling ([epipredict](https://github.com/cmu-delphi/epipredict)).
4040

4141
## Usage
42-
You can find detailed docs here:
43-
[https://cmu-delphi.github.io/epidatr/](https://cmu-delphi.github.io/epidatr/)
42+
43+
You can find detailed docs here:
4444

4545
``` r
4646
library(epidatr)
@@ -90,22 +90,26 @@ ggplot(epidata, aes(x = time_value, y = value)) +
9090
<img src="man/figures/README-fb-cli-signal-1.png" width="100%" />
9191

9292
## Installation
93+
9394
You can install the stable version of this package from CRAN:
9495

9596
``` r
97+
```R
9698
install.packages("epidatr")
9799
pak::pkg_install("epidatr")
98100
renv::install("epidatr")
99101
```
100102

101-
Or if you want the development version, install from GitHub:
102103

103-
``` r
104-
# Install the dev version using `pak` or `remotes`
105-
pak::pkg_install("cmu-delphi/epidatr")
106-
renv::install("cmu-delphi/epidatr")
107-
remotes::install_github("cmu-delphi/epidatr")
108-
```
104+
Or if you want the development version, install from GitHub:
105+
106+
```R
107+
```R
108+
# Install the dev version using `pak` or `remotes`
109+
pak::pkg_install("cmu-delphi/epidatr")
110+
remotes::install_github("cmu-delphi/epidatr")
111+
112+
\`\`\`
109113

110114
### API Keys
111115

-20.3 KB
Loading

man/get_api_key.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)