Merge pull request #787 from cmu-delphi/release/delphi-epidata-0.3.5

Release Delphi Epidata 0.3.5

Author: krivard

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.3.4
+current_version = 0.3.5
 commit = False
 tag = False
 

docs/api/covidcast-signals/google-symptoms.md

@@ -11,7 +11,7 @@ grand_parent: COVIDcast Epidata API
 * **Earliest issue available:** November 30, 2020
 * **Number of data revisions since May 19, 2020:** 0
 * **Date of last change:** Never
-* **Available for:** county, MSA, HRR, state (see [geography coding docs](../covidcast_geography.md))
+* **Available for:** county, MSA, HRR, state, HHS, nation (see [geography coding docs](../covidcast_geography.md))
 * **Time type:** day (see [date format docs](../covidcast_times.md))
 * **License:** To download or use the data, you must agree to the Google [Terms of Service](https://policies.google.com/terms)
 
@@ -57,13 +57,22 @@ The state-level and county-level `raw_search` signals for specific symptoms such
 as _anosmia_ and _ageusia_ are taken directly from the [COVID-19 Search Trends
 symptoms
 dataset](https://github.com/google-research/open-covid-19-data/tree/master/data/exports/search_trends_symptoms_dataset)
-without changes. We aggregate the county-level data to the MSA and HRR levels
-using the population-weighted average. For MSAs/HRRs that include counties that
-have no data provided due to quality or privacy issues for a certain day, we
-simply assume the values to be 0 during aggregation. The values for MSAs/HRRs
-with no counties having non-NaN values will not be reported. Thus, the resulting
-MSA/HRR level data does not fully match the _actual_ MSA/HRR level data (which
-we are not provided).
+without changes. 
+
+We aggregate county and state data to other geographic levels using
+population-weighted averaging. 
+
+| Source level | Aggregated level |
+| ------------ | ---------------- |
+| county       | MSA, HRR         |
+| state        | HHS, nation      |
+
+For aggregation purposes only, we assign a value of 0 to source regions that
+have no data provided due to quality or privacy issues for a certain day (see
+Limitations for details). We do not report aggregated regions if none of their
+source regions have data. Because of this censoring behavior, the resulting data
+for aggregated regions does not fully match the _actual_ search volume for these
+regions (which is not provided to us).
 
 ## Lag and Backfill
 Google does not currently update the search data daily, but usually twice a week.

src/client/delphi_epidata.R

@@ -15,7 +15,7 @@ Epidata <- (function() {
   # API base url
   BASE_URL <- 'https://delphi.cmu.edu/epidata/api.php'
 
-  client_version <- '0.3.4'
+  client_version <- '0.3.5'
 
   # Helper function to cast values and/or ranges to strings
   .listitem <- function(value) {

src/client/delphi_epidata.js

@@ -22,7 +22,7 @@
   }
 })(this, function (exports, fetchImpl, jQuery) {
   const BASE_URL = "https://delphi.cmu.edu/epidata/";
-  const client_version = "0.3.4";
+  const client_version = "0.3.5";
 
   // Helper function to cast values and/or ranges to strings
   function _listitem(value) {

src/client/packaging/npm/package.json

@@ -2,7 +2,7 @@
   "name": "delphi_epidata",
   "description": "Delphi Epidata API Client",
   "authors": "Delphi Group",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "license": "MIT",
   "homepage": "https://github.com/cmu-delphi/delphi-epidata",
   "bugs": {

src/client/packaging/pypi/delphi_epidata/__init__.py

@@ -1,4 +1,4 @@
 from .delphi_epidata import Epidata
 
 name = 'delphi_epidata'
-__version__ = '0.3.4'
+__version__ = '0.3.5'

src/client/packaging/pypi/setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="delphi_epidata",
-    version="0.3.4",
+    version="0.3.5",
     author="David Farrow",
     author_email="[email protected]",
     description="A programmatic interface to Delphi's Epidata API.",

src/server/_config.py

@@ -5,7 +5,7 @@
 
 load_dotenv()
 
-VERSION = "0.3.4"
+VERSION = "0.3.5"
 
 MAX_RESULTS = int(10e6)
 MAX_COMPATIBILITY_RESULTS = int(3650)