Skip to content

Commit f53d09a

Browse files
authored
Merge pull request #253 from dfarrow0/dfarrow_readme
update readme
2 parents 2482b6a + b65476f commit f53d09a

File tree

2 files changed

+36
-36
lines changed

2 files changed

+36
-36
lines changed

README.md

Lines changed: 15 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,22 @@ This is the home of [Delphi](https://delphi.cmu.edu/)'s epidemiological data
88
API. See our [API documentation](https://cmu-delphi.github.io/delphi-epidata/)
99
for details on the available data sets, APIs, and clients.
1010

11-
# COVID-19 Notice
11+
## COVIDcast
1212

13-
We are working on collecting several new data sources that may be useful for
14-
nowcasting and forecasting ILI during the COVID-19 pandemic. Each of these will
15-
make these available as soon as individually possible, through our [covidcast
16-
endpoint](https://cmu-delphi.github.io/delphi-epidata/api/covidcast.html).
13+
At the present, our primary focus is developing and expanding the
14+
[COVIDcast API](https://cmu-delphi.github.io/delphi-epidata/api/covidcast.html),
15+
which offers a number of data streams relating to the ongoing COVID-19
16+
pandemic and powers the [COVIDcast project](https://covidcast.cmu.edu/).
1717

18-
For a list of many other data sources relevant to COVID-19, publicly available
19-
through external sites, we have compiled a simple
20-
[spreadsheet](https://docs.google.com/spreadsheets/d/16Nn_3ZvSLnpxRyA2DkoMMzyrd11-AlGJXasS0owln88/edit#gid=0).
18+
Our other, non-COVID data sources remain generally available on a best-effort
19+
basis. However, non-COVID sources should be held to scrutiny at this time since
20+
they were designed to serve as indicators of typical seasonal ILI
21+
(influenza-like illness), not pandemic ILI or CLI (COVID-like illness).
2122

22-
**Note:** apart from the COVID-19-specific data sources described above, the
23-
rest of this repository was built to support modeling and forecasting efforts
24-
surrounding seasonal influenza (and dengue). All other data sources than those
25-
in our covidcast endpoint should be **held to great scrutiny** (if they are even
26-
to be considered at all in this pandemic period), since they were designed to
27-
serve as indicators of typical seasonal ILI (influenza-like illness), and
28-
certainly not pandemic ILI or CLI (covid-like illness).
23+
For a high-level introduction to the COVIDcast API, see our recent
24+
[blog post](https://delphi.cmu.edu/blog/2020/10/07/accessing-open-covid-19-data-via-the-covidcast-epidata-api/).
2925

30-
## Contributing
26+
# Contributing
3127

3228
If you are interested in contributing:
3329

@@ -37,36 +33,19 @@ If you are interested in contributing:
3733
[open an issue](https://github.com/cmu-delphi/delphi-epidata/issues/new)
3834
describing your idea.
3935

40-
## Citing
36+
# Citing
4137

4238
We hope that this API is useful to others outside of our group, especially for
4339
epidemiological and other scientific research. If you use this API and would
4440
like to cite it, we would gratefully recommend the following copy:
4541

4642
> David C. Farrow,
4743
> Logan C. Brooks,
48-
> Aaron Rumack,
4944
> Ryan J. Tibshirani,
5045
> Roni Rosenfeld
5146
> (2015).
5247
> _Delphi Epidata API_.
5348
> https://github.com/cmu-delphi/delphi-epidata
5449
55-
# Related work
56-
57-
- Cook, Samantha, et al. "Assessing Google flu trends performance in the United
58-
States during the 2009 influenza virus A (H1N1) pandemic." PloS one 6.8
59-
(2011): e23610.
60-
- Broniatowski, David A., Michael J. Paul, and Mark Dredze. "National and local
61-
influenza surveillance through Twitter: an analysis of the 2012-2013
62-
influenza epidemic." (2013): e83672.
63-
- Dredze, Mark, et al. "HealthTweets. org: A Platform for Public Health
64-
Surveillance using Twitter." AAAI Conference on Artificial
65-
Intelligence. 2014.
66-
- Generous, Nicholas, et al. "Global disease monitoring and forecasting with
67-
Wikipedia." (2014): e1003892.
68-
- Hickmann, Kyle S., et al. "Forecasting the 2013–2014 Influenza Season Using
69-
Wikipedia." (2015): e1004239.
70-
- McIver, David J., and John S. Brownstein. "Wikipedia usage estimates
71-
prevalence of influenza-like illness in the United States in near real-time."
72-
PLoS Comput Biol 10.4 (2014): e1003581.
50+
See [related work](docs/related_work.md) for a sample of additional work in
51+
this area.

docs/related_work.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Related work
2+
3+
The works listed below, along with numerous others, were an early inspiration
4+
for the Epidata API:
5+
6+
- Cook, Samantha, et al. "Assessing Google flu trends performance in the United
7+
States during the 2009 influenza virus A (H1N1) pandemic." PloS one 6.8
8+
(2011): e23610.
9+
- Broniatowski, David A., Michael J. Paul, and Mark Dredze. "National and local
10+
influenza surveillance through Twitter: an analysis of the 2012-2013
11+
influenza epidemic." (2013): e83672.
12+
- Dredze, Mark, et al. "HealthTweets. org: A Platform for Public Health
13+
Surveillance using Twitter." AAAI Conference on Artificial
14+
Intelligence. 2014.
15+
- Generous, Nicholas, et al. "Global disease monitoring and forecasting with
16+
Wikipedia." (2014): e1003892.
17+
- Hickmann, Kyle S., et al. "Forecasting the 2013–2014 Influenza Season Using
18+
Wikipedia." (2015): e1004239.
19+
- McIver, David J., and John S. Brownstein. "Wikipedia usage estimates
20+
prevalence of influenza-like illness in the United States in near real-time."
21+
PLoS Comput Biol 10.4 (2014): e1003581.

0 commit comments

Comments
 (0)