Skip to content

Highlight epidatr readiness #1458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 30, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 37 additions & 23 deletions docs/api/client_libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,39 +8,39 @@ nav_order: 1

For anyone looking for COVIDCast data, please visit our [COVIDCast Libraries](covidcast_clients.md).

We are currently working on fully-featured Epidata clients for R and Python. They are not ready
for release yet, but you can track our development progress and help us test them out at:
A full-featured Epidata client for R is available at
[epidatr](https://github.com/cmu-delphi/epidatr) and
[also on CRAN](https://cran.r-project.org/web/packages/epidatr/index.html).

* [epidatr](https://github.com/cmu-delphi/epidatr)
* [epidatpy](https://github.com/cmu-delphi/epidatpy)
We are currently working on a new full-featured Epidata client for Python. It is not ready
for release yet, but you can track our development progress and help us test it out at
[epidatpy](https://github.com/cmu-delphi/epidatpy).

In the meantime, minimalist Epidata clients remain available for
[JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/master/src/client/delphi_epidata.js),
[Python](https://github.com/cmu-delphi/delphi-epidata/blob/master/src/client/delphi_epidata.py),
[JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/master/src/client/delphi_epidata.js),
and
[R](https://github.com/cmu-delphi/delphi-epidata/blob/master/src/client/delphi_epidata.R).
[R (legacy)](https://github.com/cmu-delphi/delphi-epidata/blob/master/src/client/delphi_epidata.R).
The following samples show how to import the library and fetch Delphi's COVID-19
Surveillance Streams from Facebook Survey CLI for county 06001 and days
Surveillance Streams from Facebook Survey CLI for county 06001, and days
`20200401` and `20200405-20200414` (11 days total).

### JavaScript (in a web browser)

The minimalist JavaScript client does not currently support API keys. If you need API key support in JavaScript, contact [email protected].
### R

````html
<!-- Imports -->
<script src="delphi_epidata.js"></script>
<!-- Fetch data -->
<script>
EpidataAsync.covidcast('fb-survey', 'smoothed_cli', 'day', 'county', [20200401, EpidataAsync.range(20200405, 20200414)], '06001').then((res) => {
console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
});
</script>
````R
# [Optional] configure your API key, if desired
# Interactive. See https://cmu-delphi.github.io/epidatr/articles/epidatr.html#api-keys for details.
#save_api_key()
# Import
library(epidatr)
# Fetch data
res <- pub_covidcast('fb-survey', 'smoothed_cli', 'county', 'day', geo_values = '06001',
time_values = c(20200401, 20200405:20200414))
cat(res)
````

### Python


Optionally install the [package from PyPI](https://pypi.org/project/delphi-epidata/) using pip(env):
````bash
pip install delphi-epidata
Expand All @@ -60,15 +60,29 @@ res = Epidata.covidcast('fb-survey', 'smoothed_cli', 'day', 'county', [20200401,
print(res['result'], res['message'], len(res['epidata']))
````

### R
### JavaScript (in a web browser)

The minimalist JavaScript client does not currently support API keys. If you need API key support in JavaScript, contact [email protected].

````R
````html
<!-- Imports -->
<script src="delphi_epidata.js"></script>
<!-- Fetch data -->
<script>
EpidataAsync.covidcast('fb-survey', 'smoothed_cli', 'day', 'county', [20200401, EpidataAsync.range(20200405, 20200414)], '06001').then((res) => {
console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
});
</script>
````

### R (legacy)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"legacy"... dig it!


```R
# [Optional] configure your API key, if desired
#option('epidata.auth', <your API key>)
# Import
source('delphi_epidata.R')
# Fetch data
res <- Epidata$covidcast('fb-survey', 'smoothed_cli', 'day', 'county', list(20200401, Epidata$range(20200405, 20200414)), '06001')
cat(paste(res$result, res$message, length(res$epidata), "\n"))
````
```
Loading