Skip to content

Link docs to public repos #229

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.

Sign up for GitHub

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 3 commits into from
Oct 1, 2020
Merged

Link docs to public repos #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2dde24
Link to the public repos
capnrefsmmat Sep 30, 2020
8d1b929
Update list of signals to match new names (mostly)
capnrefsmmat Sep 30, 2020
d7bdf24
Reorganize main COVIDcast page slightly
capnrefsmmat Sep 30, 2020
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
38 changes: 25 additions & 13 deletions docs/api/covidcast.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,14 @@ and other divisions.

This data is freely available under our [licensing](README.md#data-licensing)
terms; we encourage academic users to [cite](README.md#citing) the data if they
use it in any publications. Further documentation on Delphi's APIs is available
use it in any publications. Our [data ingestion
code](https://github.com/cmu-delphi/covidcast-indicators) and [API server
code](https://github.com/cmu-delphi/delphi-epidata) is open-source, and
contributions are welcome. Further documentation on Delphi's APIs is available
in the [API overview](README.md).

<div style="background-color:#FCC; padding: 10px 30px;"><strong>For
users:</strong> Delphi operates a <a
<div style="background-color:#FCC; padding: 10px 30px;"><strong>Get
updates:</strong> Delphi operates a <a
href="https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api">mailing
list</a> for users of the COVIDcast API. We will use the list to announce API
changes, corrections to data, and new features; API users may also use the
Expand All @@ -32,12 +35,23 @@ strongly encourage you to <a
href="https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api">subscribe</a>.
</div>

## Accessing the API
## Table of contents
{: .no_toc .text-delta}

1. TOC
{:toc}

## Accessing the Data

Our [COVIDcast site](https://covidcast.cmu.edu) provides an interactive
visualization of a select set of the data signals available in the COVIDcast
API, and also provides a data export feature to download any range of data as a
CSV file.

Several [API clients are available](covidcast_clients.md) for common programming
languages, so you do not need to construct API calls yourself. Once you install
the appropriate client for your programming language, accessing data is as easy
as, in [R](https://www.r-project.org/):
languages, so you do not need to construct API calls yourself to obtain
COVIDcast data. Once you install the appropriate client for your programming
language, accessing data is as easy as, in [R](https://www.r-project.org/):

```r
library(covidcast)
Expand Down Expand Up @@ -73,20 +87,18 @@ outpatient doctor's visits, and other sources. Many of these are publicly
available *only* through the COVIDcast API.

The [signals documentation](covidcast_signals.md) describes all available
sources and signals. Furthermore, our [COVIDcast
site](https://covidcast.cmu.edu) provides an interactive visualization of a
select set of these data signals.
sources and signals.

## Constructing API Queries

The COVIDcast API is based on HTTP GET queries and returns data in JSON form.
The base URL is https://api.covidcast.cmu.edu/epidata/api.php. The covidcast
endpoint is https://api.covidcast.cmu.edu/epidata/api.php?source=covidcast.
The base URL is `https://api.covidcast.cmu.edu/epidata/api.php`. The covidcast
endpoint is `https://api.covidcast.cmu.edu/epidata/api.php?source=covidcast`.

See [this documentation](README.md) for details on specifying epiweeks, dates,
and lists.

### Parameters
### Query Parameters

#### Required

Expand Down
25 changes: 16 additions & 9 deletions docs/api/covidcast_signals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,33 @@ The API for retrieving data from these sources is described in the
[COVIDcast API endpoint documentation](covidcast.md). Changes and corrections to
data in this API are listed in the [API changelog](covidcast_changelog.md).

To obtain many of these signals and update them daily, Delphi has written
extensive software to obtain data from various sources, aggregate the data,
calculate statistical estimates, and format the data to be shared through the
COVIDcast API. This code is [open source and available on
GitHub](https://github.com/cmu-delphi/covidcast-indicators), and contributions
are welcome.

## COVIDcast Map Signals

The following signals are currently displayed on [the public COVIDcast
map](https://covidcast.cmu.edu/):

| Kind | Name | Source | Signal |
| ---- | ---- | ------ | ------ |
| Public Behavior | Away from Home 6hr+ (SafeGraph) | [`safegraph`](covidcast-signals/safegraph.md) | `full_time_work_prop` |
| Public Behavior | Away from Home 3-6hr (SafeGraph) | [`safegraph`](covidcast-signals/safegraph.md) | `part_time_work_prop` |
| Public Behavior | Search Trends (Google) | [`ght`](covidcast-signals/ght.md) | `smoothed_search` |
| Early Indicators | Symptoms (Facebook) | [`fb-survey`](covidcast-signals/fb-survey.md) | `smoothed_cli` |
| Early Indicators | Symptoms in Community (Facebook) | [`fb-survey`](covidcast-signals/fb-survey.md) | `smoothed_hh_cmnty_cli` |
| Early Indicators | Doctor's Visits | [`doctor-visits`](covidcast-signals/doctor-visits.md) | `smoothed_adj_cli` |
| Early Indicators | Combined | [`indicator-combination`](covidcast-signals/indicator-combination.md) | `nmf_day_doc_fbc_fbs_ght` |
| Late Indicators | Test Positivity Rate | [`quidel`](covidcast-signals/quidel.md) | `covid_ag_smoothed_pct_positive` |
| Public Behavior | Away from Home 6hr+ a Day | [`safegraph`](covidcast-signals/safegraph.md) | `full_time_work_prop` |
| Public Behavior | Away from Home 3-6hr a Day | [`safegraph`](covidcast-signals/safegraph.md) | `part_time_work_prop` |
| Public Behavior | COVID Searches on Google | [`ght`](covidcast-signals/ght.md) | `smoothed_search` |
| Early Indicators | COVID-Like Symptoms | [`fb-survey`](covidcast-signals/fb-survey.md) | `smoothed_cli` |
| Early Indicators | COVID-Like Symptoms in Community | [`fb-survey`](covidcast-signals/fb-survey.md) | `smoothed_hh_cmnty_cli` |
| Early Indicators | COVID-Related Doctor Visits | [`doctor-visits`](covidcast-signals/doctor-visits.md) | `smoothed_adj_cli` |
| Early Indicators | COVID Indicator Combination | [`indicator-combination`](covidcast-signals/indicator-combination.md) | `nmf_day_doc_fbc_fbs_ght` |
| Late Indicators | COVID Antigen Test Positivity (Quidel) | [`quidel`](covidcast-signals/quidel.md) | `covid_ag_smoothed_pct_positive` |
| Late Indicators | COVID Hospital Admissions | [`hospital-admissions`](covidcast-signals/hospital-admissions.md) | `smoothed_adj_covid19` |
| Late Indicators | Cases | [`indicator-combination`](covidcast-signals/indicator-combination.md) | `confirmed_7dav_incidence_num` |
| Late Indicators | Cases per 100,000 People | [`indicator-combination`](covidcast-signals/indicator-combination.md) | `confirmed_7dav_incidence_prop` |
| Late Indicators | Deaths | [`indicator-combination`](covidcast-signals/indicator-combination.md) | `deaths_7dav_incidence_num` |
| Late Indicators | Deaths per 100,000 People | [`indicator-combination`](covidcast-signals/indicator-combination.md) | `deaths_7dav_incidence_prop` |
| Late Indicators | Hospital Admissions | [`hospital-admissions`](covidcast-signals/hospital-admissions.md) | `smoothed_adj_covid19` |

## All Available Sources and Signals

Expand Down