diff --git a/docs/api/client_libraries.md b/docs/api/client_libraries.md index 8bea7f667..5d4abb956 100644 --- a/docs/api/client_libraries.md +++ b/docs/api/client_libraries.md @@ -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 delphi-support+privacy@andrew.cmu.edu. +### R -````html - - - - +````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 @@ -60,10 +60,24 @@ 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 delphi-support+privacy@andrew.cmu.edu. -````R +````html + + + + +```` + +### R (legacy) + +```R # [Optional] configure your API key, if desired #option('epidata.auth', ) # Import @@ -71,4 +85,4 @@ 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")) -```` +```