Skip to content

Commit 6ff3b4a

Browse files
authored
Merge pull request #205 from cmu-delphi/docs/copyedits
General documentation improvements
2 parents 6f061f8 + b5a11b4 commit 6ff3b4a

File tree

3 files changed

+37
-21
lines changed

3 files changed

+37
-21
lines changed

docs/api/covidcast.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ as, in [R](https://www.r-project.org/):
4242
```r
4343
library(covidcast)
4444

45-
data <- covidcast_signal("fb-survey", "smoothed_cli", start_day = "20200501",
46-
end_day = "20200507")
45+
data <- covidcast_signal("fb-survey", "smoothed_cli", start_day = "2020-05-01",
46+
end_day = "2020-05-07")
4747
```
4848

4949
or, in [Python](https://www.python.org):
@@ -56,8 +56,11 @@ data = covidcast.signal("fb-survey", "smoothed_cli", date(2020, 5, 1), date(2020
5656
"county")
5757
```
5858

59-
Alternately, for full API access, [see below](#constructing-api-queries) for
60-
details on how to construct URLs and parse responses to access data manually.
59+
[The API clients](covidcast_clients.md) have extensive documentation providing
60+
further examples.
61+
62+
Alternately, to construct URLs and parse responses to access data manually, [see
63+
below](#constructing-api-queries) for details.
6164

6265
## Data Sources and Signals
6366

docs/api/covidcast_clients.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ Dedicated COVIDcast clients are available for several languages:
1212
* Python: [covidcast](https://cmu-delphi.github.io/covidcast/covidcast-py/html/)
1313

1414
These packages provide a convenient way to obtain COVIDcast data as a data frame
15-
ready to be used in further analyses. For installation instructions and
16-
examples, consult their respective webpages.
15+
ready to be used in further analyses, and provide convenient mapping and
16+
analysis functions. For installation instructions and examples, consult their
17+
respective webpages.
1718

1819
## Generic Epidata Clients
1920

docs/api/covidcast_geography.md

+27-15
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ whose estimate is being reported. Estimates are available for several possible
1414
* `county`: County-level estimates are reported by the county's five-digit [FIPS
1515
code](https://en.wikipedia.org/wiki/FIPS_county_code). All FIPS codes are
1616
reported using pre-2015 FIPS code assignments, *except* for FIPS codes used by
17-
the `jhu-csse` source. These are reported exactly as JHU reports their data;
18-
[see below](#fips-exceptions-in-jhu-data).
17+
the `jhu-csse` and `usa-facts` sources. These are reported exactly as the
18+
sources report their data; [see below](#coding-exceptions). FIPS codes ending
19+
in `000` are not valid counties, and instead represent "megacounties" we
20+
construct; [see below](#small-sample-sizes-and-megacounties).
1921
* `hrr`: Hospital Referral Region, units designed to represent regional health
2022
care markets. There are roughly 300 HRRs in the United States. A map is
2123
available
@@ -29,10 +31,11 @@ whose estimate is being reported. Estimates are available for several possible
2931
media markets, as [defined by
3032
Nielsen](https://www.nielsen.com/us/en/intl-campaigns/dma-maps/).
3133
* `state`: The 50 states, identified by their two-digit postal abbreviation (in
32-
lower case). Estimates for Puerto Rico are available as state `pr`; Washington, D.C. is available as state `dc`.
34+
lower case). Estimates for Puerto Rico are available as state `pr`;
35+
Washington, D.C. is available as state `dc`.
3336

3437
Some signals are not available for all `geo_type`s, since they may be reported
35-
from their original sources with different levels of aggregation.
38+
by their original sources with different levels of aggregation.
3639

3740
## Table of contents
3841
{: .no_toc .text-delta}
@@ -50,18 +53,27 @@ identification of respondents, violating privacy and confidentiality agreements.
5053
Additional considerations for specific signals are discussed in the [source and
5154
signal documentation](covidcast_signals.md).
5255

53-
In each state, we collect together the data from all counties with insufficient
54-
data to be individually reported. These counties are combined into a single
55-
"megacounty". For example, if only five counties in a state have sufficient data
56-
to be reported, the remaining counties will form one megacounty representing the
57-
rest of that state. As sample sizes vary from day to day, the counties composing
58-
the megacounty can vary daily; the geographic area covered by the megacounty is
59-
simply the state minus the counties reported for that day.
56+
On each day, in each state, we collect together the data from all counties with
57+
insufficient data to be individually reported. These counties are combined into
58+
a single "megacounty". For example, if only five counties in a state have
59+
sufficient data to be reported, the remaining counties will form one megacounty
60+
representing the rest of that state. Megacounty estimates are reported with a
61+
FIPS code ending with `000`, which is never a FIPS code for a real county. For
62+
example, megacounty estimates for the state of New York are reported with FIPS
63+
code `36000`, since `36` is the FIPS code prefix for New York.
6064

61-
Megacounty estimates are reported with a FIPS code ending with 000, which is
62-
never a FIPS code for a real county. For example, megacounty estimates for the
63-
state of New York are reported with FIPS code 36000, since 36 is the FIPS code
64-
prefix for New York.
65+
These megacounty estimates are used on our COVIDcast map and in the county maps
66+
produced by our [API clients](covidcast_clients.md), to color in the background
67+
of states and graphically represent the "rest of" states whose counties are not
68+
all individually reported.
69+
70+
**Warning:** As sample sizes vary from day to day, the counties composing the
71+
megacounty can vary daily; the geographic area covered by the megacounty is
72+
simply the state minus the counties reported for that day. The megacounty
73+
construction also depends on the specific source and signal, so on one day,
74+
megacounty `36000` can cover a different geographic area for the `doctor-visits`
75+
source than it does for the `fb-survey` source. Do not try to compare megacounty
76+
estimates across time or between signals.
6577

6678
## Coding Exceptions
6779

0 commit comments

Comments
 (0)