From 320929ba154e3e13311cbcb648bc3da0c0e68596 Mon Sep 17 00:00:00 2001 From: Katie Mazaitis Date: Tue, 31 Aug 2021 14:50:48 -0400 Subject: [PATCH 1/4] Update new endpoint tutorial Remove remaining outdated materials --- docs/new_endpoint_tutorial.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/new_endpoint_tutorial.md b/docs/new_endpoint_tutorial.md index 87a1a3b11..3ec6ddf30 100644 --- a/docs/new_endpoint_tutorial.md +++ b/docs/new_endpoint_tutorial.md @@ -12,7 +12,7 @@ In this tutorial we'll create a brand new endpoint for the Epidata API: `fluview_meta`. At a high level, we'll do the following steps: 1. understand the data that we want to surface -2. add the new endpoint to `api.php` +2. add the new endpoint to the API server 3. add the new endpoint to the various client libraries 4. write an integration test for the new endpoint 5. update API documentation for the new endpoint @@ -328,8 +328,7 @@ actual [pull request for the `fluview_meta` endpoint](https://github.com/cmu-delphi/delphi-epidata/pull/93) created in this tutorial. -Once it's approved, commit the code. Within a short amount of time (usually ~30 -seconds), the API will begin serving your new endpoint. Go ahead and give it a +Once it's approved, merge the PR, and contact an admin to schedule a release. Once released, the API will begin serving your new endpoint. Go ahead and give it a try: https://delphi.cmu.edu/epidata/fluview_meta/ ``` From 80b72143607b5289ba55d41741a19d61f4e815dc Mon Sep 17 00:00:00 2001 From: krivard Date: Wed, 1 Sep 2021 14:36:50 +0000 Subject: [PATCH 2/4] chore: update docs --- src/server/endpoints/covidcast_utils/db_signals.csv | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/server/endpoints/covidcast_utils/db_signals.csv b/src/server/endpoints/covidcast_utils/db_signals.csv index 97bf65eae..938fc9cd2 100644 --- a/src/server/endpoints/covidcast_utils/db_signals.csv +++ b/src/server/endpoints/covidcast_utils/db_signals.csv @@ -290,9 +290,13 @@ google-symptoms,anosmia_raw_search,TRUE,anosmia_smoothed_search,TRUE,{base_name} google-symptoms,sum_anosmia_ageusia_raw_search,FALSE,sum_anosmia_ageusia_raw_search,FALSE,Sum Anosmia Ageusia Searches,TRUE,"The sum of Google search volume for anosmia and ageusia related searches, in arbitrary units that are normalized for overall search users",,day,Date,Value,raw,public,bad,FALSE,FALSE,FALSE,FALSE,FALSE, google-symptoms,sum_anosmia_ageusia_raw_search,TRUE,sum_anosmia_ageusia_smoothed_search,TRUE,{base_name} (7-day average),TRUE,,,day,Date,Value,raw,public,bad,TRUE,FALSE,FALSE,FALSE,FALSE, hhs,confirmed_admissions_covid_1d,FALSE,confirmed_admissions_covid_1d,FALSE,Confirmed COVID-19 Admissions per day,TRUE,Sum of adult and pediatric confirmed COVID-19 hospital admissions occurring each day. ,,day,Date,Value,count,late,bad,FALSE,FALSE,FALSE,FALSE,FALSE, +hhs,confirmed_admissions_covid_1d,TRUE,confirmed_admissions_covid_1d_prop,FALSE,{base_name} (per 100k people),TRUE,,,day,Date,Value,per100k,late,bad,FALSE,FALSE,FALSE,FALSE,FALSE, hhs,confirmed_admissions_covid_1d,,confirmed_admissions_covid_1d_7dav,TRUE,{base_name} (7-day average),TRUE,,,day,Date,Value,count,late,bad,TRUE,FALSE,FALSE,FALSE,FALSE, +hhs,confirmed_admissions_covid_1d,,confirmed_admissions_covid_1d_prop_7dav,FALSE,"{base_name} (7-day average, per 100k people)",TRUE,,,day,Date,Value,per100k,late,bad,TRUE,FALSE,FALSE,FALSE,FALSE, hhs,sum_confirmed_suspected_admissions_covid_1d,FALSE,sum_confirmed_suspected_admissions_covid_1d,FALSE,Confirmed and Suspected COVID-19 Admissions per day,TRUE,Sum of adult and pediatric confirmed and suspected COVID-19 hospital admissions occurring each day. ,,day,Date,Value,count,late,bad,FALSE,FALSE,FALSE,FALSE,FALSE, +hhs,sum_confirmed_suspected_admissions_covid_1d,TRUE,sum_confirmed_suspected_admissions_covid_1d_prop,FALSE,{base_name} (per 100k people),TRUE,,,day,Date,Value,per100k,late,bad,FALSE,FALSE,FALSE,FALSE,FALSE, hhs,sum_confirmed_suspected_admissions_covid_1d,,sum_confirmed_suspected_admissions_covid_1d_7dav,TRUE,{base_name} (7-day average),TRUE,,,day,Date,Value,count,late,bad,TRUE,FALSE,FALSE,FALSE,FALSE, +hhs,sum_confirmed_suspected_admissions_covid_1d,,sum_confirmed_suspected_admissions_covid_1d_prop_7dav,FALSE,"{base_name} (7-day average, per 100k people)",TRUE,,,day,Date,Value,per100k,late,bad,TRUE,FALSE,FALSE,FALSE,FALSE, hospital-admissions,smoothed_covid19,FALSE,smoothed_covid19,FALSE,COVID-19 Admissions (EMR and Claims),FALSE,Estimated percentage of new hospital admissions with COVID-associated diagnoses,"{short_description}, based on counts of electronic medical records and claims from health system partners, smoothed in time using a Gaussian linear smoother. Discontinued October 1, 2020.",day,Date,Value,percent,late,bad,TRUE,FALSE,FALSE,FALSE,FALSE, From e2b3c3ee76b310e19c65e7fa87eda3e8c8655acb Mon Sep 17 00:00:00 2001 From: Kathryn M Mazaitis Date: Wed, 1 Sep 2021 10:42:44 -0400 Subject: [PATCH 3/4] Add HHS prop signals to API documentation --- docs/api/covidcast-signals/hhs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index 826f345a3..cee707aee 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -33,7 +33,9 @@ sum is used as the "ground truth" for hospitalizations by the [COVID-19 Forecast | Signal | 7-day average signal | Geography | Resolution | Description | | --- | --- | --- | --- | --- | | `confirmed_admissions_covid_1d` | `confirmed_admissions_covid_1d_7dav`| state | 1 day | Sum of adult and pediatric confirmed COVID-19 hospital admissions occurring each day.
**Earliest date available:** 2019-12-31 | +| `confirmed_admissions_covid_1d_prop` | `confirmed_admissions_covid_1d_prop_7dav`| state | 1 day | Sum of adult and pediatric confirmed COVID-19 hospital admissions occurring each day, per 100,000 population.
**Earliest date available:** 2019-12-31 | | `sum_confirmed_suspected_admissions_covid_1d` | `sum_confirmed_suspected_admissions_covid_1d_7dav` | state | 1 day | Sum of adult and pediatric confirmed and suspected COVID-19 hospital admissions occurring each day.
**Earliest date available:** 2019-12-31 | +| `sum_confirmed_suspected_admissions_covid_1d_prop` | `sum_confirmed_suspected_admissions_covid_1d_prop_7dav` | state | 1 day | Sum of adult and pediatric confirmed and suspected COVID-19 hospital admissions occurring each day, per 100,000 population.
**Earliest date available:** 2019-12-31 | The 7-day average signals are computed by Delphi by calculating moving averages of the preceding 7 days, so e.g. the signal for June 7 is the From a855b57d0206161f08e40e0523e16cec616a2df1 Mon Sep 17 00:00:00 2001 From: krivard Date: Thu, 2 Sep 2021 20:29:16 +0000 Subject: [PATCH 4/4] chore: release delphi-epidata 0.2.12 --- .bumpversion.cfg | 2 +- src/client/delphi_epidata.R | 2 +- src/client/delphi_epidata.js | 2 +- src/client/packaging/npm/package.json | 2 +- src/client/packaging/pypi/delphi_epidata/__init__.py | 2 +- src/client/packaging/pypi/setup.py | 2 +- src/server/_config.py | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index a359592bf..d268d2d73 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.2.11 +current_version = 0.2.12 commit = False tag = False diff --git a/src/client/delphi_epidata.R b/src/client/delphi_epidata.R index 469c61879..85a7c8f95 100644 --- a/src/client/delphi_epidata.R +++ b/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.2.11' + client_version <- '0.2.12' # Helper function to cast values and/or ranges to strings .listitem <- function(value) { diff --git a/src/client/delphi_epidata.js b/src/client/delphi_epidata.js index 0b6b7b9bd..9764c61ab 100644 --- a/src/client/delphi_epidata.js +++ b/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.2.11"; + const client_version = "0.2.12"; // Helper function to cast values and/or ranges to strings function _listitem(value) { diff --git a/src/client/packaging/npm/package.json b/src/client/packaging/npm/package.json index 2696b7711..6a951a23c 100644 --- a/src/client/packaging/npm/package.json +++ b/src/client/packaging/npm/package.json @@ -2,7 +2,7 @@ "name": "delphi_epidata", "description": "Delphi Epidata API Client", "authors": "Delphi Group", - "version": "0.2.11", + "version": "0.2.12", "license": "MIT", "homepage": "https://github.com/cmu-delphi/delphi-epidata", "bugs": { diff --git a/src/client/packaging/pypi/delphi_epidata/__init__.py b/src/client/packaging/pypi/delphi_epidata/__init__.py index 09d8687a4..5ae5e8277 100644 --- a/src/client/packaging/pypi/delphi_epidata/__init__.py +++ b/src/client/packaging/pypi/delphi_epidata/__init__.py @@ -1,4 +1,4 @@ from .delphi_epidata import Epidata name = 'delphi_epidata' -__version__ = '0.2.11' +__version__ = '0.2.12' diff --git a/src/client/packaging/pypi/setup.py b/src/client/packaging/pypi/setup.py index cdbd3591b..02faf994f 100644 --- a/src/client/packaging/pypi/setup.py +++ b/src/client/packaging/pypi/setup.py @@ -5,7 +5,7 @@ setuptools.setup( name="delphi_epidata", - version="0.2.11", + version="0.2.12", author="David Farrow", author_email="dfarrow0@gmail.com", description="A programmatic interface to Delphi's Epidata API.", diff --git a/src/server/_config.py b/src/server/_config.py index 4f053bd66..55b83247a 100644 --- a/src/server/_config.py +++ b/src/server/_config.py @@ -5,7 +5,7 @@ load_dotenv() -VERSION = "0.2.11" +VERSION = "0.2.12" MAX_RESULTS = int(10e6) MAX_COMPATIBILITY_RESULTS = int(3650)