diff --git a/Python-packages/covidcast-py/covidcast/covidcast.py b/Python-packages/covidcast-py/covidcast/covidcast.py index c080ecab..0a3f88e3 100644 --- a/Python-packages/covidcast-py/covidcast/covidcast.py +++ b/Python-packages/covidcast-py/covidcast/covidcast.py @@ -7,12 +7,22 @@ import pandas as pd import numpy as np from delphi_epidata import Epidata +from delphi_epidata.delphi_epidata import _HEADERS +from pkg_resources import get_distribution, DistributionNotFound from epiweeks import Week from .errors import NoDataWarning + # Point API requests to the default endpoint -Epidata.BASE_URL = "https://api.covidcast.cmu.edu/epidata/api.php" +Epidata.BASE_URL = "https://api.covidcast.cmu.edu/epidata" +# Prepend to Epidata client's user agent to specify this package and version +try: + _ver = get_distribution("covidcast").version +except DistributionNotFound: + _ver = "0.0.0" +_HEADERS['user-agent'] = f"covidcast/{_ver} " + _HEADERS['user-agent'] + VALID_GEO_TYPES = {"county", "hrr", "msa", "dma", "state", "hhs", "nation"} @@ -463,7 +473,7 @@ def _async_fetch_epidata(data_source: str, issues: Union[date, tuple, list], lag: int, time_type: str = "day") -> Union[pd.DataFrame, None]: - """Fetch data from Epidata API asynchronously. + """Fetch data from Epidata API asynchronously [DEPRECATED]. signal() wraps this to support fetching data over a range of dates and stacks the resulting data frames. @@ -471,6 +481,8 @@ def _async_fetch_epidata(data_source: str, If no data is found, return None, so signal() can easily filter out these entries. """ + warnings.warn("`_async_fetch_epidata` is deprecated and will be removed in a future version.", + category=DeprecationWarning) dfs = [] params = [] date_range = pd.date_range(start_day, end_day, freq="D" if time_type == "day" else "W") diff --git a/Python-packages/covidcast-py/docs/changelog.rst b/Python-packages/covidcast-py/docs/changelog.rst index 86c2c2dd..9ef4336c 100644 --- a/Python-packages/covidcast-py/docs/changelog.rst +++ b/Python-packages/covidcast-py/docs/changelog.rst @@ -1,6 +1,14 @@ Changelog ========= +v0.2.2, October 10, 2023 +-------------------- + +- New feature: Web requests now identify themselves with a `covidcast`-specific "user agent" string. +- Update: Now uses newer version of the `delphi-epidata` libarary. +- Bug fix: Removed usage of PHP alias endpoint for compatibility with new `delphi-epidata` version. +- Deprecated function: Private method :py:func:`_async_fetch_epidata` has been deprecated. + v0.2.1, June 1, 2023 -------------------- diff --git a/Python-packages/covidcast-py/docs/conf.py b/Python-packages/covidcast-py/docs/conf.py index a95f5c7c..4589097a 100644 --- a/Python-packages/covidcast-py/docs/conf.py +++ b/Python-packages/covidcast-py/docs/conf.py @@ -21,7 +21,7 @@ author = 'Delphi research group' # The full version, including alpha/beta/rc tags -release = '0.2.1' +release = '0.2.2' # -- General configuration --------------------------------------------------- diff --git a/Python-packages/covidcast-py/setup.py b/Python-packages/covidcast-py/setup.py index 8e11a755..d5df51ea 100644 --- a/Python-packages/covidcast-py/setup.py +++ b/Python-packages/covidcast-py/setup.py @@ -5,7 +5,7 @@ setuptools.setup( name="covidcast", - version="0.2.1", # also update in docs/conf.py + version="0.2.2", # also update in docs/conf.py author="Alex Reinhart", author_email="areinhar@stat.cmu.edu", description="Access COVID-19 data through the Delphi COVIDcast API", @@ -22,7 +22,7 @@ install_requires=[ "pandas<2", "requests", - "delphi-epidata>=4.1.1", + "delphi-epidata>=4.1.11,==4.*", "geopandas", "matplotlib", "numpy", diff --git a/Python-packages/covidcast-py/tests/test_covidcast.py b/Python-packages/covidcast-py/tests/test_covidcast.py index 6fff9879..1592d280 100644 --- a/Python-packages/covidcast-py/tests/test_covidcast.py +++ b/Python-packages/covidcast-py/tests/test_covidcast.py @@ -265,19 +265,25 @@ def test__async_fetch_epidata(mock_async_epidata): with warnings.catch_warnings(record=True) as w: covidcast._async_fetch_epidata("source", "signal", date(2020, 4, 2), date(2020, 4, 2), "*", None, None, None, None) - assert len(w) == 1 + assert len(w) == 2 # including deprecation warning assert str(w[0].message) == \ + "`_async_fetch_epidata` is deprecated and will be removed in a future version." + assert w[0].category is DeprecationWarning + assert str(w[1].message) == \ "Problem obtaining source signal data on 20200402 for geography '*': failed" - assert w[0].category is RuntimeWarning + assert w[1].category is RuntimeWarning # test warning when a no data response is received mock_async_epidata.return_value = [({"message": "no results"}, {"time_values": 20200402})] # no data API response with warnings.catch_warnings(record=True) as w: covidcast._async_fetch_epidata("source", "signal", date(2020, 4, 2), date(2020, 4, 2), "county", None, None, None, None) - assert len(w) == 1 - assert str(w[0].message) == "No source signal data found on 20200402 for geography 'county'" - assert w[0].category is NoDataWarning + assert len(w) == 2 # including deprecation warning + assert str(w[0].message) == \ + "`_async_fetch_epidata` is deprecated and will be removed in a future version." + assert w[0].category is DeprecationWarning + assert str(w[1].message) == "No source signal data found on 20200402 for geography 'county'" + assert w[1].category is NoDataWarning # test no epidata yields nothing mock_async_epidata.return_value = [({"message": "success"}, None)] # no epidata diff --git a/docs/covidcast-py/doctrees/changelog.doctree b/docs/covidcast-py/doctrees/changelog.doctree index 5c9366e0..94067203 100644 Binary files a/docs/covidcast-py/doctrees/changelog.doctree and b/docs/covidcast-py/doctrees/changelog.doctree differ diff --git a/docs/covidcast-py/doctrees/environment.pickle b/docs/covidcast-py/doctrees/environment.pickle index 8d88fa18..7d0d9ca5 100644 Binary files a/docs/covidcast-py/doctrees/environment.pickle and b/docs/covidcast-py/doctrees/environment.pickle differ diff --git a/docs/covidcast-py/doctrees/getting_started.doctree b/docs/covidcast-py/doctrees/getting_started.doctree index 8252ddc4..af615915 100644 Binary files a/docs/covidcast-py/doctrees/getting_started.doctree and b/docs/covidcast-py/doctrees/getting_started.doctree differ diff --git a/docs/covidcast-py/doctrees/index.doctree b/docs/covidcast-py/doctrees/index.doctree index acd90e1f..be2b8725 100644 Binary files a/docs/covidcast-py/doctrees/index.doctree and b/docs/covidcast-py/doctrees/index.doctree differ diff --git a/docs/covidcast-py/doctrees/plot_examples.doctree b/docs/covidcast-py/doctrees/plot_examples.doctree index 48113221..b1cb773b 100644 Binary files a/docs/covidcast-py/doctrees/plot_examples.doctree and b/docs/covidcast-py/doctrees/plot_examples.doctree differ diff --git a/docs/covidcast-py/doctrees/plotting.doctree b/docs/covidcast-py/doctrees/plotting.doctree index 8811561a..318d8b4f 100644 Binary files a/docs/covidcast-py/doctrees/plotting.doctree and b/docs/covidcast-py/doctrees/plotting.doctree differ diff --git a/docs/covidcast-py/doctrees/signals.doctree b/docs/covidcast-py/doctrees/signals.doctree index 834c105c..ab601dfa 100644 Binary files a/docs/covidcast-py/doctrees/signals.doctree and b/docs/covidcast-py/doctrees/signals.doctree differ diff --git a/docs/covidcast-py/html/.buildinfo b/docs/covidcast-py/html/.buildinfo index a4105c1c..340b591b 100644 --- a/docs/covidcast-py/html/.buildinfo +++ b/docs/covidcast-py/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: adc91b801928f140c7be8ffe81e03415 +config: cbbd65a1377a79b8be99216462605909 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/covidcast-py/html/_sources/changelog.rst.txt b/docs/covidcast-py/html/_sources/changelog.rst.txt index 86c2c2dd..9ef4336c 100644 --- a/docs/covidcast-py/html/_sources/changelog.rst.txt +++ b/docs/covidcast-py/html/_sources/changelog.rst.txt @@ -1,6 +1,14 @@ Changelog ========= +v0.2.2, October 10, 2023 +-------------------- + +- New feature: Web requests now identify themselves with a `covidcast`-specific "user agent" string. +- Update: Now uses newer version of the `delphi-epidata` libarary. +- Bug fix: Removed usage of PHP alias endpoint for compatibility with new `delphi-epidata` version. +- Deprecated function: Private method :py:func:`_async_fetch_epidata` has been deprecated. + v0.2.1, June 1, 2023 -------------------- diff --git a/docs/covidcast-py/html/_static/basic.css b/docs/covidcast-py/html/_static/basic.css index 7577acb1..30fee9d0 100644 --- a/docs/covidcast-py/html/_static/basic.css +++ b/docs/covidcast-py/html/_static/basic.css @@ -237,6 +237,10 @@ a.headerlink { visibility: hidden; } +a:visited { + color: #551A8B; +} + h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, @@ -670,6 +674,16 @@ dd { margin-left: 30px; } +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + dl > dd:last-child, dl > dd:last-child > :last-child { margin-bottom: 0; @@ -738,6 +752,14 @@ abbr, acronym { cursor: help; } +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + /* -- code displays --------------------------------------------------------- */ pre { diff --git a/docs/covidcast-py/html/_static/documentation_options.js b/docs/covidcast-py/html/_static/documentation_options.js index dd1759df..033e08ef 100644 --- a/docs/covidcast-py/html/_static/documentation_options.js +++ b/docs/covidcast-py/html/_static/documentation_options.js @@ -1,6 +1,5 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.2.1', +const DOCUMENTATION_OPTIONS = { + VERSION: '0.2.2', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/covidcast-py/html/_static/pygments.css b/docs/covidcast-py/html/_static/pygments.css index 9abe04ba..57c7df37 100644 --- a/docs/covidcast-py/html/_static/pygments.css +++ b/docs/covidcast-py/html/_static/pygments.css @@ -22,6 +22,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ .highlight .gd { color: #a40000 } /* Generic.Deleted */ .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000 } /* Generic.EmphStrong */ .highlight .gr { color: #ef2929 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ diff --git a/docs/covidcast-py/html/_static/searchtools.js b/docs/covidcast-py/html/_static/searchtools.js index 97d56a74..7918c3fa 100644 --- a/docs/covidcast-py/html/_static/searchtools.js +++ b/docs/covidcast-py/html/_static/searchtools.js @@ -57,12 +57,12 @@ const _removeChildren = (element) => { const _escapeRegExp = (string) => string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string -const _displayItem = (item, searchTerms) => { +const _displayItem = (item, searchTerms, highlightTerms) => { const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; const [docName, title, anchor, descr, score, _filename] = item; @@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => { if (dirname.match(/\/index\/$/)) dirname = dirname.substring(0, dirname.length - 6); else if (dirname === "index/") dirname = ""; - requestUrl = docUrlRoot + dirname; + requestUrl = contentRoot + dirname; linkUrl = requestUrl; } else { // normal html builders - requestUrl = docUrlRoot + docName + docFileSuffix; + requestUrl = contentRoot + docName + docFileSuffix; linkUrl = docName + docLinkSuffix; } let linkEl = listItem.appendChild(document.createElement("a")); linkEl.href = linkUrl + anchor; linkEl.dataset.score = score; linkEl.innerHTML = title; - if (descr) + if (descr) { listItem.appendChild(document.createElement("span")).innerHTML = " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } else if (showSearchSummary) fetch(requestUrl) .then((responseData) => responseData.text()) @@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => { listItem.appendChild( Search.makeSearchSummary(data, searchTerms) ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); }); Search.output.appendChild(listItem); }; @@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => { const _displayNextItem = ( results, resultCount, - searchTerms + searchTerms, + highlightTerms, ) => { // results left, load the summary and display it // this is intended to be dynamic (don't sub resultsCount) if (results.length) { - _displayItem(results.pop(), searchTerms); + _displayItem(results.pop(), searchTerms, highlightTerms); setTimeout( - () => _displayNextItem(results, resultCount, searchTerms), + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), 5 ); } @@ -360,7 +368,7 @@ const Search = { // console.info("search results:", Search.lastresults); // print the results - _displayNextItem(results, results.length, searchTerms); + _displayNextItem(results, results.length, searchTerms, highlightTerms); }, /** diff --git a/docs/covidcast-py/html/_static/sphinx_highlight.js b/docs/covidcast-py/html/_static/sphinx_highlight.js index aae669d7..8a96c69a 100644 --- a/docs/covidcast-py/html/_static/sphinx_highlight.js +++ b/docs/covidcast-py/html/_static/sphinx_highlight.js @@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => { } span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); parent.insertBefore( span, parent.insertBefore( - document.createTextNode(val.substr(pos + text.length)), + rest, node.nextSibling ) ); node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); if (isInSVG) { const rect = document.createElementNS( @@ -140,5 +145,10 @@ const SphinxHighlight = { }, }; -_ready(SphinxHighlight.highlightSearchWords); -_ready(SphinxHighlight.initEscapeListener); +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/docs/covidcast-py/html/changelog.html b/docs/covidcast-py/html/changelog.html index f1618c46..04d4fc20 100644 --- a/docs/covidcast-py/html/changelog.html +++ b/docs/covidcast-py/html/changelog.html @@ -1,17 +1,17 @@ - + - + - Changelog — COVIDcast API client 0.2.1 documentation - - - - - - + Changelog — COVIDcast API client 0.2.2 documentation + + + + + + @@ -32,9 +32,18 @@
-

Changelog

+

Changelog

+
+

v0.2.2, October 10, 2023

+
    +
  • New feature: Web requests now identify themselves with a covidcast-specific “user agent” string.

  • +
  • Update: Now uses newer version of the delphi-epidata libarary.

  • +
  • Bug fix: Removed usage of PHP alias endpoint for compatibility with new delphi-epidata version.

  • +
  • Deprecated function: Private method _async_fetch_epidata() has been deprecated.

  • +
+
-

v0.2.1, June 1, 2023

+

v0.2.1, June 1, 2023

  • Bug fix: Corrected how API keys are installed in the underlying interface.

  • Bug fix: Corrected minimum dependency version for delphi-epidata library.

  • @@ -42,7 +51,7 @@

    v0.2.1, June 1, 2023 -

    v0.2.0, May 23, 2023

    +

    v0.2.0, May 23, 2023

    • New feature: This package now supports queries that require an API key. Call covidcast.use_api_key() before running fetch functions to @@ -50,7 +59,7 @@

      v0.2.0, May 23, 2023 -

      v0.1.5, May 11, 2021

      +

      v0.1.5, May 11, 2021

      • New feature: covidcast.signal() now supports fetching signals using time_type="week" (when available from the Epidata API).

      • @@ -58,27 +67,27 @@

        v0.1.5, May 11, 2021 -

        v0.1.4, February 24, 2021

        +

        v0.1.4, February 24, 2021

        • New feature: covidcast.signal() can now use asynchronous calls. It is primarily for Delphi internal use; please consult with us if you intend to use this feature.

-

v0.1.3, January 5, 2021

+

v0.1.3, January 5, 2021

  • New feature: covidcast.signal() now retrieves HHS (geo_type="hhs") and nation (geo_type="nation") level signals (if available from the Epidata API).

-

v0.1.2, December 10, 2020

+

v0.1.2, December 10, 2020

-

v0.1.1, November 22, 2020

+

v0.1.1, November 22, 2020

-

v0.0.9, August 30, 2020

+

v0.0.9, August 30, 2020

  • New feature: covidcast.plot_choropleth() and covidcast.get_geo_df() add mapping and plotting capabilities that can be used with the data returned by @@ -133,7 +142,7 @@

    v0.0.9, August 30, 2020

-

v0.0.8, July 26, 2020

+

v0.0.8, July 26, 2020

  • New feature: covidcast.signal() now accepts arguments as_of, issues, and lag to request data that was issued on a specific date, or @@ -144,14 +153,14 @@

    v0.0.8, July 26, 2020

-

v0.0.7, June 29, 2020

+

v0.0.7, June 29, 2020

  • Addition: covidcast.metadata() returns a data frame of all available sources and signals, with metadata about each.

-

v0.0.6, June 22, 2020

+

v0.0.6, June 22, 2020

  • Minor API change: covidcast.signal() now takes a geo_values argument that can include multiple geographies, rather than a single @@ -160,7 +169,7 @@

    v0.0.6, June 22, 2020

-

v0.0.5, June 19, 2020

+

v0.0.5, June 19, 2020

First public usable release.

@@ -188,6 +197,7 @@

Navigation

  • Plotting Examples
  • Plotting Reference
  • Changelog
  • diff --git a/docs/covidcast-py/html/getting_started.html b/docs/covidcast-py/html/getting_started.html index 447cb501..8dc24993 100644 --- a/docs/covidcast-py/html/getting_started.html +++ b/docs/covidcast-py/html/getting_started.html @@ -1,17 +1,17 @@ - + - + - Getting Started — COVIDcast API client 0.2.1 documentation - - - - - - + Getting Started — COVIDcast API client 0.2.2 documentation + + + + + + @@ -33,9 +33,9 @@
    -

    Getting Started

    +

    Getting Started

    -

    Overview

    +

    Overview

    This package provides access to data from the COVIDcast API, which provides numerous COVID-related data streams, updated daily. The data is retrieved live from the server when you make a request, and is not stored within the package @@ -45,7 +45,7 @@

    Overview -

    Installation

    +

    Installation

    This package is available on PyPI as covidcast, and can be installed using pip or your favorite Python package manager:

    pip install covidcast
    @@ -54,7 +54,7 @@ 

    Installation -

    Signal Overview

    +

    Signal Overview

    The API documentation lists the available signals, including many not shown on the COVIDcast interactive map.

    @@ -143,7 +143,7 @@

    Signal Overview -

    Basic examples

    +

    Basic examples

    To obtain smoothed estimates of COVID-like illness from our symptom survey, distributed through Facebook, for every county in the United States between 2020-05-01 and 2020-05-07:

    @@ -251,7 +251,7 @@

    Basic examples -

    Tracking issues and updates

    +

    Tracking issues and updates

    The COVIDcast API records not just each signal’s estimate for a given location on a given day, but also when that estimate was made, and all updates to that estimate.

    @@ -348,7 +348,7 @@

    Tracking issues and updates -

    Dealing with geographies

    +

    Dealing with geographies

    As seen above, the COVIDcast API identifies counties by their FIPS code and states by two-letter abbreviations. Metropolitan statistical areas are also identified by unique codes, called CBSA IDs. (Exact details and exceptions are @@ -471,7 +471,7 @@

    Quick search

    ©2023, Delphi research group. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.2.6 & Alabaster 0.7.13 | diff --git a/docs/covidcast-py/html/index.html b/docs/covidcast-py/html/index.html index ecfdf045..ce639b72 100644 --- a/docs/covidcast-py/html/index.html +++ b/docs/covidcast-py/html/index.html @@ -1,17 +1,17 @@ - + - - - COVIDcast API client — COVIDcast API client 0.2.1 documentation - - - - - - + + + COVIDcast API client — COVIDcast API client 0.2.2 documentation + + + + + + @@ -32,7 +32,7 @@
    -

    COVIDcast API client

    +

    COVIDcast API client

    This package provides Python access to the COVIDcast Epidata API published by the Delphi group at Carnegie Mellon University. This API provides daily access to a range of COVID-related signals Delphi collects from a variety of sources, including @@ -66,7 +66,7 @@

    COVIDcast API client

    -

    Contents

    +

    Contents

    • Getting Started
        @@ -98,6 +98,7 @@

        ContentsChangelog
          +
        • v0.2.2, October 10, 2023
        • v0.2.1, June 1, 2023
        • v0.2.0, May 23, 2023
        • v0.1.5, May 11, 2021
        • @@ -188,7 +189,7 @@

          Quick search

          ©2023, Delphi research group. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.2.6 & Alabaster 0.7.13 | diff --git a/docs/covidcast-py/html/plot_examples.html b/docs/covidcast-py/html/plot_examples.html index 38b9f607..294c06ab 100644 --- a/docs/covidcast-py/html/plot_examples.html +++ b/docs/covidcast-py/html/plot_examples.html @@ -1,17 +1,17 @@ - + - + - Plotting Examples — COVIDcast API client 0.2.1 documentation - - - - - - + Plotting Examples — COVIDcast API client 0.2.2 documentation + + + + + + @@ -33,9 +33,9 @@
          -

          Plotting Examples

          +

          Plotting Examples

          -

          Built-in functionality

          +

          Built-in functionality

          The returned DataFrame from covidcast.signal() can be plotted using the built-in covidcast.plot(). Currently, state, county, hospital referral regions (HRR), and metropolitan statistical area (MSA) geography types are supported.

          @@ -132,7 +132,7 @@

          Built-in functionality

          -

          Animations

          +

          Animations

          To create an animation, simply pass the signal DataFrame to covidcast.animate(). The following code creates an MP4 file named test_plot.mp4 which animates our daily signal for the month of August.

          @@ -160,7 +160,7 @@

          Animations -

          Further customization

          +

          Further customization

          If more control is desired, the signal data can be passed to covidcast.get_geo_df(), which will return a GeoPandas GeoDataFrame with @@ -309,7 +309,7 @@

          Quick search

          ©2023, Delphi research group. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.2.6 & Alabaster 0.7.13 | diff --git a/docs/covidcast-py/html/plotting.html b/docs/covidcast-py/html/plotting.html index 98d33220..666452e1 100644 --- a/docs/covidcast-py/html/plotting.html +++ b/docs/covidcast-py/html/plotting.html @@ -1,17 +1,17 @@ - + - + - Plotting Reference — COVIDcast API client 0.2.1 documentation - - - - - - + Plotting Reference — COVIDcast API client 0.2.2 documentation + + + + + + @@ -33,15 +33,15 @@
          -

          Plotting Reference

          +

          Plotting Reference

          -

          Choropleth maps

          +

          Choropleth maps

          This package provides a plotting function that takes a state, county, HRR, or MSA signal and generates a choropleth map, using matplotlib underneath. Detailed examples are provided in the usage examples.

          -covidcast.plot(data, time_value=None, plot_type='choropleth', combine_megacounties=True, **kwargs)
          +covidcast.plot(data, time_value=None, plot_type='choropleth', combine_megacounties=True, **kwargs)

          Given the output data frame of covidcast.signal(), plot a choropleth or bubble map.

          Projections used for plotting:

            @@ -67,7 +67,7 @@

            Choropleth mapsParameters:
            • data (DataFrame) – Data frame of signal values, as returned from covidcast.signal().

            • -
            • time_value (Optional[date]) – If multiple days of data are present in data, map only values from this +

            • time_value (date) – If multiple days of data are present in data, map only values from this day. Defaults to plotting the most recent day of data in data.

            • combine_megacounties (bool) – For each state, display all counties without a signal value as a single polygon with the megacounty value, as opposed to plotting all the county boundaries. @@ -87,11 +87,11 @@

              Choropleth maps -

              Animate a signal over time

              +

              Animate a signal over time

              A signal DataFrame can be used to generate an animated choropleth of the signal values over time.

              -covidcast.animate(data, filepath, fps=3, dpi=150, **kwargs)
              +covidcast.animate(data, filepath, fps=3, dpi=150, **kwargs)

              Generate an animated video file of a signal over time.

              Given a signal DataFrame, generates the choropleth for each day to form an animation of the signal. Accepts arguments for video parameters as well as optional plotting arguments. @@ -118,13 +118,13 @@

              Animate a signal over time -

              Creating a GeoDataFrame

              +

              Creating a GeoDataFrame

              A function for generating a GeoPandas GeoDataFrame with signal information appended is also provided if the user desires more control over their plotting.

              -covidcast.get_geo_df(data, geo_value_col='geo_value', geo_type_col='geo_type', join_type='right', combine_megacounties=False)
              +covidcast.get_geo_df(data, geo_value_col='geo_value', geo_type_col='geo_type', join_type='right', combine_megacounties=False)

              Augment a covidcast.signal() data frame with the shape of each geography.

              This method takes in a pandas DataFrame object and returns a GeoDataFrame object from the GeoPandas package. The @@ -258,7 +258,7 @@

              Quick search

              ©2023, Delphi research group. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.2.6 & Alabaster 0.7.13 | diff --git a/docs/covidcast-py/html/search.html b/docs/covidcast-py/html/search.html index 2e7bb6fb..3ebe9d60 100644 --- a/docs/covidcast-py/html/search.html +++ b/docs/covidcast-py/html/search.html @@ -1,17 +1,17 @@ - + - Search — COVIDcast API client 0.2.1 documentation - - - + Search — COVIDcast API client 0.2.2 documentation + + + - - - + + + @@ -124,7 +124,7 @@

              Related Topics

              ©2023, Delphi research group. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.2.6 & Alabaster 0.7.13

          diff --git a/docs/covidcast-py/html/searchindex.js b/docs/covidcast-py/html/searchindex.js index 6814f1a8..be90ee4e 100644 --- a/docs/covidcast-py/html/searchindex.js +++ b/docs/covidcast-py/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "getting_started", "index", "plot_examples", "plotting", "signals"], "filenames": ["changelog.rst", "getting_started.rst", "index.rst", "plot_examples.rst", "plotting.rst", "signals.rst"], "titles": ["Changelog", "Getting Started", "COVIDcast API client", "Plotting Examples", "Plotting Reference", "Fetching Data"], "terms": {"new": [0, 1, 2, 5], "featur": [0, 5], "thi": [0, 1, 2, 3, 4, 5], "packag": [0, 1, 2, 3, 4, 5], "now": 0, "support": [0, 1, 2, 3, 4, 5], "queri": [0, 1, 2, 5], "requir": [0, 1], "an": [0, 1, 2, 3, 4, 5], "api": [0, 1], "kei": [0, 1, 2], "call": [0, 1, 5], "covidcast": [0, 1, 3, 4, 5], "use_api_kei": [0, 1, 2, 5], "befor": [0, 5], "run": 0, "fetch": [0, 1, 2], "function": [0, 1, 2, 4, 5], "authent": [0, 2], "your": [0, 1, 2, 3, 5], "request": [0, 1, 2, 5], "signal": [0, 2, 3], "us": [0, 1, 2, 3, 4, 5], "time_typ": [0, 5], "week": [0, 5], "when": [0, 1, 3, 5], "avail": [0, 1, 2, 3, 5], "from": [0, 1, 2, 3, 4, 5], "epidata": [0, 2, 5], "bug": [0, 2], "fix": [0, 5], "better": 0, "detect": [0, 4], "error": [0, 1, 5], "condit": 0, "fail": 0, "can": [0, 1, 2, 3, 4, 5], "asynchron": 0, "It": 0, "i": [0, 1, 2, 3, 4, 5], "primarili": 0, "delphi": [0, 2, 5], "intern": 0, "pleas": [0, 1, 2], "consult": [0, 2, 5], "u": [0, 1, 3, 4], "you": [0, 1, 2, 3, 5], "intend": 0, "retriev": [0, 1], "hh": 0, "geo_typ": [0, 1, 3, 4, 5], "nation": [0, 5], "level": [0, 3, 4, 5], "issu": [0, 2, 3, 5], "where": [0, 3, 4, 5], "introduct": 0, "weekli": [0, 5], "broke": 0, "metadata": [0, 2], "A": [0, 4, 5], "shapefil": [0, 3, 4], "which": [0, 1, 2, 3, 5], "plot": [0, 2], "metropolitan": [0, 1, 3], "statist": [0, 1, 3], "area": [0, 1, 3, 4], "hospit": [0, 1, 3, 5], "referr": [0, 3, 5], "region": [0, 1, 3, 4, 5], "resolv": 0, "updat": [0, 2, 5], "direct": 0, "longer": 0, "ha": [0, 5], "been": [0, 1, 5], "remov": 0, "output": [0, 3, 4, 5], "To": [0, 1, 2, 3, 5], "measur": 0, "increas": 0, "decreas": 0, "trend": [0, 1], "we": [0, 1, 2], "recommend": 0, "implement": 0, "own": [0, 5], "method": [0, 3, 4, 5], "base": [0, 1, 5], "applic": 0, "": [0, 1, 4, 5], "specif": [0, 1, 5], "need": [0, 1, 2, 5], "fips_to_abbr": [0, 5], "abbr_to_fip": [0, 5], "convert": [0, 1, 5], "between": [0, 1, 3, 4, 5], "state": [0, 1, 3, 4], "fip": [0, 1, 4, 5], "code": [0, 1, 2, 3, 4, 5], "abbrevi": [0, 1, 5], "bubbl": [0, 3, 4], "argument": [0, 1, 3, 4, 5], "plot_typ": [0, 3, 4], "fips_to_nam": [0, 1, 5], "cbsa_to_nam": [0, 5], "abbr_to_nam": [0, 5], "ar": [0, 1, 2, 3, 4, 5], "provid": [0, 1, 2, 3, 4, 5], "cbsa": [0, 1], "id": [0, 1, 5], "two": [0, 1, 4, 5], "letter": [0, 1, 5], "counti": [0, 1, 3, 4], "name": [0, 1, 3, 4, 5], "msa": [0, 3, 4, 5], "respect": [0, 1, 5], "name_to_fip": [0, 1, 5], "name_to_cbsa": [0, 1, 5], "human": [0, 1, 5], "readabl": [0, 1, 5], "anim": [0, 2], "take": [0, 4, 5], "datafram": [0, 3, 4, 5], "return": [0, 1, 3, 4, 5], "gener": [0, 4], "video": [0, 3, 4], "over": [0, 1, 2, 5], "time": [0, 1, 2, 5], "plot_choropleth": 0, "hrr": [0, 3, 4, 5], "addit": [0, 1, 3], "aggregate_sign": [0, 1, 5], "shift": [0, 5], "combin": [0, 1, 5], "multipl": [0, 1, 4, 5], "singl": [0, 1, 3, 4, 5], "conveni": [0, 1, 5], "comparison": 0, "across": [0, 5], "The": [0, 1, 2, 3, 4, 5], "time_valu": [0, 1, 3, 4, 5], "accept": [0, 4], "datetim": [0, 1, 3, 5], "date": [0, 1, 3, 4, 5], "object": [0, 3, 4, 5], "instead": [0, 5], "onli": [0, 1, 3, 4, 5], "panda": [0, 4, 5], "timestamp": [0, 5], "duplic": 0, "valu": [0, 1, 3, 4, 5], "geo_valu": [0, 1, 3, 4, 5], "deprec": 0, "replac": 0, "get_geo_df": [0, 3, 4], "add": 0, "map": [0, 1, 2, 3], "capabl": 0, "data": [0, 1, 2, 3, 4], "see": [0, 1, 2, 3, 4, 5], "document": [0, 1, 2, 3, 4, 5], "exampl": [0, 2, 4, 5], "more": [0, 1, 2, 3, 4, 5], "detail": [0, 1, 2, 3, 4, 5], "as_of": [0, 1, 5], "lag": [0, 1, 3, 5], "wa": [0, 1, 5], "certain": [0, 1], "default": [0, 1, 2, 3, 4, 5], "behavior": 0, "most": [0, 1, 3, 4, 5], "up": [0, 5], "match": [0, 1, 4, 5], "client": [0, 5], "previou": [0, 5], "user": [0, 1, 2, 4, 5], "prior": [0, 1], "version": [0, 1, 5], "desir": [0, 1, 3, 4, 5], "frame": [0, 1, 3, 4, 5], "all": [0, 1, 2, 3, 4, 5], "sourc": [0, 1, 2, 3, 4, 5], "about": [0, 1, 4], "each": [0, 1, 3, 4, 5], "minor": 0, "chang": [0, 1, 5], "includ": [0, 1, 2, 5], "geographi": [0, 2, 3, 4, 5], "rather": [0, 1, 2], "than": [0, 1, 2, 5], "improv": 0, "first": [0, 1, 4, 5], "public": [0, 2], "usabl": 0, "releas": 0, "access": [1, 2, 5], "numer": 1, "covid": [1, 2, 3], "relat": [1, 2], "stream": [1, 5], "daili": [1, 2, 3, 5], "live": 1, "server": [1, 2], "make": [1, 2], "store": [1, 2, 3], "within": 1, "itself": 1, "mean": [1, 4, 5], "receiv": 1, "latest": 1, "If": [1, 2, 3, 4, 5], "conduct": [1, 4, 5], "analysi": [1, 5], "power": [1, 2], "servic": [1, 2], "repeat": 1, "same": [1, 5], "download": [1, 2, 5], "pypi": 1, "pip": 1, "favorit": 1, "python": [1, 2], "manag": 1, "well": [1, 4], "depend": [0, 1, 3], "list": [1, 2, 4, 5], "mani": [1, 5], "shown": 1, "interact": [1, 2], "come": 1, "varieti": [1, 2], "cover": 1, "inform": [1, 2, 3, 4, 5], "offici": 1, "case": [1, 2, 3, 5], "count": 1, "internet": 1, "search": 1, "encount": 1, "survei": [1, 2, 3, 5], "respons": 1, "below": [1, 4], "brief": 1, "link": [0, 1], "full": 1, "descript": [1, 5], "healthcar": [1, 2], "outpati": 1, "visit": 1, "diagnost": 1, "de": 1, "identifi": [1, 2, 4], "medic": 1, "claim": 1, "doctor": 1, "symptom": [1, 2], "googl": 1, "health": 1, "volum": [1, 2], "admiss": 1, "associ": [1, 5], "diagnos": 1, "indic": [1, 5], "aggreg": [1, 5], "other": [1, 2, 4, 5], "activ": 1, "jhu": 1, "death": [1, 2], "confirm": [1, 5], "report": [1, 3, 5], "made": 1, "john": 1, "hopkin": 1, "univers": [1, 2], "quidel": 1, "posit": 1, "antigen": 1, "test": 1, "safegraph": 1, "mobil": 1, "movement": 1, "phone": 1, "locat": [1, 4, 5], "variou": [1, 3], "cmu": [1, 5], "usafact": 1, "specifi": [1, 3, 5], "page": 1, "For": [1, 2, 3, 4, 5], "obtain": [1, 5], "raw": 1, "topic": 1, "would": [1, 5], "ght": 1, "raw_search": 1, "These": [1, 3, 4, 5], "smooth": 1, "estim": [1, 3, 5], "like": [1, 3, 5], "ill": 1, "our": [1, 2, 3, 5], "distribut": 1, "through": [1, 2], "facebook": 1, "everi": [1, 2, 4, 5], "unit": [1, 5], "2020": [1, 2, 3], "05": 1, "01": [1, 3], "07": 1, "import": [1, 3], "fb": [1, 3, 5], "smoothed_cli": [1, 3, 5], "5": [1, 2, 3, 4, 5], "1": [1, 2, 3, 4, 5], "7": [1, 2, 3], "head": 1, "sample_s": [1, 3, 5], "stderr": [1, 3, 5], "0": [1, 2, 3, 4], "01000": [1, 3], "23": [1, 2], "22": [1, 2], "1722": 1, "4551": 1, "125573": 1, "823080": 1, "01001": [1, 3], "115": [1, 3], "8025": 1, "800444": 1, "261261": 1, "2": [1, 2, 3, 5], "01003": [1, 3], "584": 1, "3194": 1, "308680": 1, "665129": 1, "3": [1, 2, 3, 4, 5], "01015": [1, 3], "122": [1, 3], "5577": 1, "526590": 1, "574713": 1, "4": [1, 2, 3], "01031": 1, "114": 1, "8318": 1, "347450": 1, "408163": 1, "row": [1, 3, 4, 5], "repres": [1, 3, 5], "one": [1, 3, 4, 5], "observ": [1, 4, 5], "dai": [1, 4, 5], "given": [1, 4, 5], "column": [1, 3, 4, 5], "here": [1, 5], "percentag": 1, "peopl": 1, "its": [1, 4, 5], "standard": [1, 4, 5], "mai": [1, 2, 5], "1st": 1, "were": 1, "23rd": 1, "give": [1, 5], "By": [1, 2, 3, 4, 5], "submit": [1, 2], "anonym": [1, 2, 5], "have": [1, 3, 4, 5], "normal": 1, "your_api_kei": 1, "technic": 1, "how": [0, 1, 2, 5], "calcul": [1, 5], "In": [1, 5], "explain": 1, "definit": 1, "exact": [1, 5], "text": 1, "describ": [1, 5], "mathemat": 1, "deriv": 1, "also": [1, 2, 3, 4, 5], "after": [1, 4, 5], "sinc": [1, 3], "ak": 1, "1606": 1, "0000": 1, "158880": 1, "460772": 1, "al": 1, "7540": 1, "2437": 1, "082553": 1, "699511": 1, "4921": 1, "4827": 1, "103651": 1, "759798": 1, "az": 1, "11220": 1, "9587": 1, "061794": 1, "566937": 1, "ca": [1, 3], "51870": 1, "1382": 1, "022803": 1, "364908": 1, "pennsylvania": 1, "month": [1, 3], "pa_data": 1, "31": [1, 3], "pa": 1, "31576": 1, "0165": 1, "030764": 1, "400011": 1, "21": [1, 3], "31344": 1, "0168": 1, "030708": 1, "02": 1, "394774": 1, "20": 1, "30620": 1, "0162": 1, "031173": 1, "03": 1, "396340": 1, "19": [1, 2], "30419": 1, "0163": 1, "029836": 1, "04": [1, 3], "357501": 1, "18": 1, "29245": 1, "0172": 1, "030176": 1, "354521": 1, "ny": 1, "mo": 1, "sometim": [1, 5], "join": [1, 3, 4, 5], "suppos": 1, "d": 1, "look": [1, 5], "relationship": 1, "number": [1, 5], "three": 1, "later": [1, 5], "option": [1, 4, 5], "follow": [1, 3, 5], "confirmed_incidence_num": 1, "deaths_incidence_num": 1, "cases_v_death": 1, "dt": [1, 5], "renam": 1, "combination_confirmed_incidence_num_0_valu": 1, "combination_deaths_incidence_num_1_valu": 1, "nan": [1, 3], "62": 1, "65": 1, "24": [1, 2, 3], "1209": 1, "13": [1, 3], "1332": 1, "547": 1, "result": [1, 5], "contain": [1, 3, 4, 5], "per": [1, 3, 4, 5], "abov": [1, 4], "becaus": 1, "input": [1, 3, 4, 5], "did": 1, "late": 1, "april": 1, "note": [1, 2, 3, 5], "long": 1, "prevent": 1, "ambigu": 1, "collis": 1, "record": [1, 5], "just": 1, "consid": [1, 2, 5], "That": 1, "delai": 1, "being": 1, "due": [1, 5], "taken": 1, "ingest": [1, 5], "could": 1, "perhap": 1, "arriv": 1, "constitut": 1, "recent": [1, 4, 5], "best": 1, "who": 1, "simpli": [1, 3], "want": 1, "graph": 1, "construct": 1, "dashboard": [1, 2], "But": 1, "interest": [1, 4, 5], "know": 1, "start_dai": [1, 5], "end_dai": [1, 5], "6": [1, 2, 3, 4, 5], "none": [1, 3, 4, 5], "32192": 1, "show": [1, 3], "don": 1, "t": 1, "64": 1, "075015": 1, "substanti": 1, "reflect": 1, "becam": [1, 5], "occur": 1, "illustr": 1, "particularli": 1, "forecast": 1, "task": 1, "backtest": 1, "model": [1, 5], "past": 1, "much": 1, "period": 1, "15": 1, "693061": 1, "06": [1, 3], "524167": 1, "321920": 1, "08": [1, 3], "897032": 1, "09": 1, "8": [1, 2, 3, 4], "956456": 1, "12": [1, 4, 5], "11": [1, 2], "190634": 1, "220023": 1, "14": 1, "231314": 1, "239970": 1, "clearli": 1, "never": [1, 5], "among": 1, "final": [1, 5], "correspond": [1, 3, 4, 5], "802238": 1, "483125": 1, "968670": 1, "400255": 1, "though": [1, 5], "3rd": [1, 5], "4th": 1, "set": [1, 5], "10th": 1, "fact": [1, 5], "9": [1, 2], "749537": 1, "989626": 1, "10": [1, 2], "006860": 1, "970561": 1, "038054": 1, "As": [1, 2, 3], "seen": 1, "uniqu": [1, 5], "except": 1, "geograph": [1, 2, 3, 4], "find": 1, "houston": 1, "san": 1, "antonio": 1, "26420": 1, "41700": 1, "quickli": [1, 5], "allegheni": 1, "lo": 1, "angel": 1, "miami": 1, "dade": 1, "df": [1, 3], "data_sourc": [1, 3, 5], "42003": 1, "336086": 1, "06037": 1, "787655": 1, "12086": 1, "405477": 1, "back": 1, "regular": [1, 5], "express": [1, 5], "meet": 1, "criteria": 1, "five": 1, "digit": [1, 4, 5], "begin": [1, 5], "42": [1, 3], "pa_counti": 1, "ties_method": [1, 5], "42000": 1, "42001": 1, "adam": 1, "42005": 1, "armstrong": 1, "42007": 1, "beaver": 1, "42009": 1, "bedford": 1, "42011": 1, "berk": 1, "42013": 1, "blair": 1, "42015": 1, "bradford": 1, "42017": 1, "buck": 1, "42019": 1, "butler": 1, "42021": 1, "cambria": 1, "42023": 1, "cameron": 1, "42025": 1, "carbon": 1, "42027": 1, "centr": 1, "42029": 1, "chester": 1, "42031": 1, "clarion": 1, "42033": 1, "clearfield": 1, "42035": 1, "clinton": 1, "42037": 1, "columbia": 1, "42039": 1, "crawford": 1, "42041": 1, "cumberland": 1, "42043": 1, "dauphin": 1, "42045": 1, "delawar": 1, "42047": 1, "elk": 1, "42049": 1, "eri": 1, "42051": 1, "fayett": 1, "42053": 1, "forest": 1, "42055": 1, "franklin": 1, "42057": 1, "fulton": 1, "42059": 1, "green": 1, "42061": 1, "huntingdon": 1, "42063": 1, "indiana": 1, "42065": 1, "jefferson": 1, "42067": 1, "juniata": 1, "42069": 1, "lackawanna": 1, "42071": 1, "lancast": 1, "42073": 1, "lawrenc": 1, "42075": 1, "lebanon": 1, "42077": 1, "lehigh": 1, "42079": 1, "luzern": 1, "42081": 1, "lycom": 1, "42083": 1, "mckean": 1, "42085": 1, "mercer": 1, "42087": 1, "mifflin": 1, "42089": 1, "monro": 1, "42091": 1, "montgomeri": 1, "42093": 1, "montour": 1, "42095": 1, "northampton": 1, "42097": 1, "northumberland": 1, "42099": 1, "perri": 1, "42101": 1, "philadelphia": 1, "42103": 1, "pike": 1, "42105": 1, "potter": 1, "42107": 1, "schuylkil": 1, "42109": 1, "snyder": 1, "42111": 1, "somerset": 1, "42113": 1, "sullivan": 1, "42115": 1, "susquehanna": 1, "42117": 1, "tioga": 1, "42119": 1, "union": [1, 4, 5], "42121": 1, "venango": 1, "42123": 1, "warren": 1, "42125": 1, "washington": 1, "42127": 1, "wayn": 1, "42129": 1, "westmoreland": 1, "42131": 1, "wyom": 1, "42133": 1, "york": 1, "work": [1, 2], "publish": [2, 5], "group": [2, 5], "carnegi": 2, "mellon": 2, "rang": [2, 5], "collect": [2, 5], "licens": 2, "cite": 2, "tracker": 2, "found": [2, 4, 5], "github": 2, "get": [2, 5], "start": [2, 5], "check": 2, "out": 2, "should": 2, "subscrib": 2, "mail": 2, "notifi": 2, "correct": [0, 2], "compat": 2, "some": [2, 5], "limit": [2, 5], "do": [2, 3, 4], "appli": [2, 5], "regularli": [], "frequent": [], "system": 4, "regist": 5, "free": [], "even": [], "usag": [4, 5], "fall": [], "help": [], "understand": [], "turn": [], "futur": [], "research": 2, "partnership": [], "fund": [], "instruct": [], "resourc": 2, "cannot": 2, "high": 2, "without": [2, 4, 5], "product": 2, "app": 2, "central": 2, "term": 2, "warrant": 2, "particular": 2, "purpos": [2, 4], "overview": 2, "instal": [0, 2], "basic": 2, "track": [2, 5], "deal": [2, 5], "built": 2, "further": [2, 5], "custom": [2, 4], "refer": 2, "choropleth": [2, 3], "creat": [2, 3, 5], "geodatafram": [2, 3], "changelog": 2, "v0": 2, "_": [], "2023": 2, "2021": 2, "februari": 2, "januari": 2, "decemb": 2, "novemb": 2, "octob": 2, "august": [2, 3], "30": [2, 3], "juli": 2, "26": 2, "june": [2, 5], "29": 2, "current": [3, 4, 5], "type": [3, 4, 5], "color": [3, 4], "polygon": [3, 4], "megacounti": [3, 4], "insuffici": 3, "sampl": [3, 5], "size": [3, 5], "matplotlib": [3, 4], "pyplot": 3, "plt": 3, "png": 3, "hire": 3, "pdf": 3, "present": [3, 4], "light": 3, "grei": 3, "demonstr": 3, "altern": 3, "keyword": [3, 4], "geopanda": [3, 4], "cmap": 3, "viridi": 3, "edgecolor": 3, "figur": [3, 4], "alter": 3, "fig": 3, "set_dpi": 3, "100": 3, "pass": [3, 4], "mp4": 3, "file": [3, 4], "test_plot": 3, "browser": 3, "doe": 3, "html5": 3, "element": 3, "format": [3, 4, 5], "rate": [3, 4, 5], "resolut": [3, 5], "adjust": 3, "static": 3, "test_plot2": 3, "fp": [3, 4], "control": [3, 4], "relev": 3, "polgon": 3, "tool": 3, "geometri": [3, 4], "2019": [3, 4], "censu": [3, 4], "cartograph": [3, 4], "boundari": [3, 4], "differ": [3, 4, 5], "try": 3, "comput": 3, "right": [3, 4], "left": [3, 4], "side": [3, 4], "so": [3, 4, 5], "possibl": 3, "fill": 3, "those": [3, 4], "inherit": 3, "sing": 3, "combine_megacounti": [3, 4], "true": [3, 4, 5], "oper": 3, "must": [3, 4, 5], "anoth": 3, "join_typ": [3, 4, 5], "state_fip": [3, 4], "24510": 3, "375601": 3, "193356": 3, "587": 3, "6289": 3, "76": 3, "71131": 3, "39": 3, "37193": 3, "62619": 3, "372": 3, "31169": 3, "928208": 3, "168783": 3, "1059": 3, "8130": 3, "97": 3, "82082": 3, "40": 3, "35054": 3, "36869": 3, "350": 3, "37077": 3, "627742": 3, "081884": 3, "3146": 3, "0176": 3, "78": 3, "80252": 3, "36": 3, "21349": 3, "80235": 3, "220": 3, "37": 3, "46091": 3, "589745": 3, "161989": 3, "778": 3, "7429": 3, "97924": 3, "45": 3, "76257": 3, "97878": 3, "935": 3, "46": 3, "39075": 3, "785641": 3, "099959": 3, "2767": 3, "5054": 3, "82": 3, "22066": 3, "66758": 3, "12620": 3, "668": 3, "3228": 3, "53055": 3, "440817": 3, "143404": 3, "944": 3, "1731": 3, "multipolygon": 3, "97714": 3, "48": 3, "79345": 3, "9379": 3, "53": 3, "3229": 3, "39133": 3, "040082": 3, "089324": 3, "310": 3, "8495": 3, "81": 3, "39328": 3, "41": 3, "02544": 3, "39322": 3, "040": 3, "3230": 3, "08025": 3, "440306": 3, "123763": 3, "1171": 3, "5823": 3, "104": 3, "05840": 3, "38": 3, "26084": 3, "05392": 3, "3231": 3, "13227": 3, "009511": 3, "092993": 3, "3605": 3, "8731": 3, "84": 3, "65437": 3, "34": 3, "54895": 3, "52139": 3, "550": 3, "3232": 3, "21145": 3, "257862": 3, "915558": 3, "150": [3, 4], "4266": 3, "88": 3, "93308": 3, "22775": 3, "93174": 3, "227": 3, "3233": 3, "x": 3, "153447": 3, "136070": 3, "1759": 3, "8539": 3, "539568": 3, "450588": 3, "107": 3, "9345": 3, "86": 3, "91759": 3, "32": 3, "66417": 3, "81657": 3, "660": 3, "625496": 3, "522036": 3, "455": 3, "2964": 3, "02927": 3, "22271": 3, "02399": 3, "230": 3, "000000": 3, "378788": 3, "2302": 3, "14371": 3, "33": 3, "70913": 3, "12388": 3, "710": 3, "01051": 3, "786565": 3, "435877": 3, "112": 3, "5569": 3, "41333": 3, "75059": 3, "37497": 3, "753": 3, "840": 3, "55141": 3, "190476": 3, "867751": 3, "144": 3, "3682": 3, "90": 3, "31605": 3, "44": 3, "42450": 3, "31596": 3, "424": 3, "55": 3, "841": 3, "56000": 3, "822092": 3, "254670": 3, "628": 3, "9937": 3, "842": 3, "56021": 3, "269360": 3, "315094": 3, "197": 3, "9646": 3, "105": 3, "28064": 3, "33100": 3, "27824": 3, "56": 3, "843": 3, "56025": 3, "170940": 3, "304654": 3, "192": 3, "0237": 3, "54353": 3, "78156": 3, "50142": 3, "844": 3, "72000": 3, "228310": 3, "9990": 3, "845": 3, "With": 3, "point": 3, "whatev": 3, "style": 3, "prefer": 3, "california": 3, "mercat": 3, "project": [3, 4], "geo_data": 3, "loc": 3, "to_cr": 3, "epsg": 3, "3395": 3, "true_valu": 3, "figsiz": 3, "legend": 3, "axi": 3, "off": 3, "underneath": 4, "kwarg": 4, "esri": 4, "102003": 4, "usa": [4, 5], "contigu": 4, "alber": 4, "equal": 4, "conic": 4, "puerto": 4, "rico": 4, "102006": 4, "alaska": 4, "102007": 4, "hawaii": 4, "visual": 4, "move": 4, "lower": 4, "corner": 4, "closer": 4, "florida": 4, "colormap": 4, "ylorrd": 4, "scale": 4, "histor": 4, "deviat": [4, 5], "customiz": 4, "purpl": 4, "discret": 4, "bin": 4, "displai": 4, "white": 4, "std": 4, "dev": 4, "highest": 4, "paramet": [4, 5], "bool": [4, 5], "oppos": 4, "ani": [4, 5], "str": [4, 5], "either": [4, 5], "filepath": 4, "dpi": 4, "form": 4, "imageio": 4, "ffmpeg": 4, "path": 4, "save": 4, "filenam": 4, "extens": 4, "int": [4, 5], "second": 4, "dot": 4, "inch": 4, "8x9": 4, "1920x1440": 4, "append": [4, 5], "geo_value_col": 4, "geo_type_col": 4, "fals": [4, 5], "augment": 4, "shape": 4, "build": [4, 5], "cm": 4, "geo": 4, "them": [4, 5], "alwai": 4, "regardless": [4, 5], "whether": [4, 5], "outer": [4, 5], "inner": 4, "select": [4, 5], "constitu": 4, "000": [4, 5], "websit": 4, "along": 4, "span": 4, "gc": 4, "nad83": 4, "coordin": 4, "wgs84": 4, "subsequ": 5, "string": 5, "anyon": 5, "maximum": 5, "etc": 5, "exempt": 5, "http": 5, "gle": [], "hkbr5sfqgxguafet7": [], "polici": 5, "underli": [0, 5], "5th": 5, "onc": 5, "becom": 5, "revis": 5, "8th": 5, "allow": 5, "mutual": 5, "exclus": 5, "prioriti": 5, "initi": 5, "ask": 5, "6th": 5, "enforc": 5, "beyond": 5, "truncat": 5, "suffici": 5, "automat": 5, "split": 5, "howev": 5, "warn": 5, "discuss": 5, "round": 5, "epiweek": 5, "e": 5, "sundai": 5, "inclus": 5, "iter": 5, "tupl": 5, "end": 5, "There": 5, "sever": 5, "integ": 5, "exactli": 5, "tempor": 5, "mmwr": 5, "downstream": 5, "recogn": 5, "might": 5, "quantiti": 5, "confirmed_cumulative_num": 5, "cumul": 5, "privaci": 5, "constraint": 5, "pars": 5, "correctli": 5, "part": 5, "produc": 5, "index": 5, "front": 5, "separ": 5, "underscor": 5, "g": 5, "source_signal_0_inputcolumn": 5, "origin": 5, "drop": 5, "forward": 5, "jan": 5, "length": 5, "done": 5, "least": 5, "surveil": 5, "publicli": 5, "hss": 5, "henc": 5, "min_tim": 5, "max_tim": 5, "num_loc": 5, "distinct": 5, "ever": 5, "min_valu": 5, "smallest": 5, "max_valu": 5, "largest": 5, "mean_valu": 5, "arithmet": 5, "stdev_valu": 5, "last_upd": 5, "utc": 5, "last": 5, "max_issu": 5, "min_lag": 5, "max_lag": 5, "while": 5, "ignore_cas": 5, "individu": 5, "boolean": 5, "insensit": 5, "ignor": 5, "sensit": 5, "determin": 5, "dict": 5, "restrict": 5, "abbr": 5, "name_to_abbr": 5, "12000": 5, "interfac": 0, "minimum": 0, "librari": 0, "registr": 0, "edu": 5, "admin": 5, "registration_form": 5}, "objects": {"covidcast": [[5, 0, 1, "", "abbr_to_fips"], [5, 0, 1, "", "abbr_to_name"], [5, 0, 1, "", "aggregate_signals"], [4, 0, 1, "", "animate"], [5, 0, 1, "", "cbsa_to_name"], [5, 0, 1, "", "fips_to_abbr"], [5, 0, 1, "", "fips_to_name"], [4, 0, 1, "", "get_geo_df"], [5, 0, 1, "", "metadata"], [5, 0, 1, "", "name_to_abbr"], [5, 0, 1, "", "name_to_cbsa"], [5, 0, 1, "", "name_to_fips"], [4, 0, 1, "", "plot"], [5, 0, 1, "", "signal"], [5, 0, 1, "", "use_api_key"]]}, "objtypes": {"0": "py:function"}, "objnames": {"0": ["py", "function", "Python function"]}, "titleterms": {"changelog": 0, "v0": 0, "1": 0, "6": 0, "mai": 0, "_": [], "2023": 0, "5": 0, "11": 0, "2021": 0, "4": 0, "februari": 0, "24": 0, "3": 0, "januari": 0, "2": 0, "decemb": 0, "10": 0, "2020": 0, "novemb": 0, "22": 0, "0": 0, "octob": 0, "9": 0, "august": 0, "30": 0, "8": 0, "juli": 0, "26": 0, "7": 0, "june": 0, "29": 0, "19": 0, "get": 1, "start": 1, "overview": 1, "instal": 1, "signal": [1, 4, 5], "basic": 1, "exampl": [1, 3], "track": 1, "issu": 1, "updat": 1, "deal": 1, "geographi": 1, "covidcast": 2, "api": [2, 5], "client": 2, "content": 2, "plot": [3, 4], "built": 3, "function": 3, "anim": [3, 4], "further": 3, "custom": 3, "refer": 4, "choropleth": 4, "map": 4, "over": 4, "time": 4, "creat": 4, "geodatafram": 4, "fetch": 5, "data": 5, "kei": 5, "metadata": 5, "work": 5, "geograph": 5, "identifi": 5, "counti": 5, "metropolitan": 5, "statist": 5, "area": 5, "state": 5, "23": 0}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Changelog": [[0, "changelog"]], "v0.2.1, June 1, 2023": [[0, "v0-2-1-june-1-2023"]], "v0.2.0, May 23, 2023": [[0, "v0-2-0-may-23-2023"]], "v0.1.5, May 11, 2021": [[0, "v0-1-5-may-11-2021"]], "v0.1.4, February 24, 2021": [[0, "v0-1-4-february-24-2021"]], "v0.1.3, January 5, 2021": [[0, "v0-1-3-january-5-2021"]], "v0.1.2, December 10, 2020": [[0, "v0-1-2-december-10-2020"]], "v0.1.1, November 22, 2020": [[0, "v0-1-1-november-22-2020"]], "v0.1.0, October 1, 2020": [[0, "v0-1-0-october-1-2020"]], "v0.0.9, August 30, 2020": [[0, "v0-0-9-august-30-2020"]], "v0.0.8, July 26, 2020": [[0, "v0-0-8-july-26-2020"]], "v0.0.7, June 29, 2020": [[0, "v0-0-7-june-29-2020"]], "v0.0.6, June 22, 2020": [[0, "v0-0-6-june-22-2020"]], "v0.0.5, June 19, 2020": [[0, "v0-0-5-june-19-2020"]], "Getting Started": [[1, "getting-started"]], "Overview": [[1, "overview"]], "Installation": [[1, "installation"]], "Signal Overview": [[1, "signal-overview"]], "Basic examples": [[1, "basic-examples"]], "Tracking issues and updates": [[1, "tracking-issues-and-updates"]], "Dealing with geographies": [[1, "dealing-with-geographies"]], "Plotting Examples": [[3, "plotting-examples"]], "Built-in functionality": [[3, "built-in-functionality"]], "Animations": [[3, "animations"]], "Further customization": [[3, "further-customization"]], "Plotting Reference": [[4, "plotting-reference"]], "Choropleth maps": [[4, "choropleth-maps"]], "Animate a signal over time": [[4, "animate-a-signal-over-time"]], "Creating a GeoDataFrame": [[4, "creating-a-geodataframe"]], "Fetching Data": [[5, "fetching-data"]], "API keys": [[5, "api-keys"]], "Signals": [[5, "signals"]], "Metadata": [[5, "metadata"]], "Working with geographic identifiers": [[5, "working-with-geographic-identifiers"]], "Counties": [[5, "counties"]], "Metropolitan statistical areas": [[5, "metropolitan-statistical-areas"]], "States": [[5, "states"]], "COVIDcast API client": [[2, "covidcast-api-client"]], "Contents": [[2, "contents"]]}, "indexentries": {}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "getting_started", "index", "plot_examples", "plotting", "signals"], "filenames": ["changelog.rst", "getting_started.rst", "index.rst", "plot_examples.rst", "plotting.rst", "signals.rst"], "titles": ["Changelog", "Getting Started", "COVIDcast API client", "Plotting Examples", "Plotting Reference", "Fetching Data"], "terms": {"remov": 0, "usag": [0, 4, 5], "php": 0, "alia": 0, "python": [1, 2], "client": [0, 5], "bug": [0, 2], "fix": [0, 5], "correct": [0, 2], "how": [0, 1, 2, 5], "api": [0, 1], "kei": [0, 1, 2], "ar": [0, 1, 2, 3, 4, 5], "instal": [0, 2], "underli": [0, 5], "interfac": 0, "minimum": 0, "depend": [0, 1, 3], "version": [0, 1, 5], "delphi": [0, 2, 5], "epidata": [0, 2, 5], "librari": 0, "updat": [0, 2, 5], "replac": 0, "link": [0, 1], "registr": 0, "new": [0, 1, 2, 5], "featur": [0, 5], "thi": [0, 1, 2, 3, 4, 5], "packag": [0, 1, 2, 3, 4, 5], "now": 0, "support": [0, 1, 2, 3, 4, 5], "queri": [0, 1, 2, 5], "requir": [0, 1], "an": [0, 1, 2, 3, 4, 5], "call": [0, 1, 5], "covidcast": [0, 1, 3, 4, 5], "use_api_kei": [0, 1, 2, 5], "befor": [0, 5], "run": 0, "fetch": [0, 1, 2], "function": [0, 1, 2, 4, 5], "authent": [0, 2], "your": [0, 1, 2, 3, 5], "request": [0, 1, 2, 5], "signal": [0, 2, 3], "us": [0, 1, 2, 3, 4, 5], "time_typ": [0, 5], "week": [0, 5], "when": [0, 1, 3, 5], "avail": [0, 1, 2, 3, 5], "from": [0, 1, 2, 3, 4, 5], "better": 0, "detect": [0, 4], "error": [0, 1, 5], "condit": 0, "fail": 0, "can": [0, 1, 2, 3, 4, 5], "asynchron": 0, "It": 0, "i": [0, 1, 2, 3, 4, 5], "primarili": 0, "intern": 0, "pleas": [0, 1, 2], "consult": [0, 2, 5], "u": [0, 1, 3, 4], "you": [0, 1, 2, 3, 5], "intend": 0, "retriev": [0, 1], "hh": 0, "geo_typ": [0, 1, 3, 4, 5], "nation": [0, 5], "level": [0, 3, 4, 5], "issu": [0, 2, 3, 5], "where": [0, 3, 4, 5], "introduct": 0, "weekli": [0, 5], "broke": 0, "metadata": [0, 2], "A": [0, 4, 5], "shapefil": [0, 3, 4], "which": [0, 1, 2, 3, 5], "plot": [0, 2], "metropolitan": [0, 1, 3], "statist": [0, 1, 3], "area": [0, 1, 3, 4], "hospit": [0, 1, 3, 5], "referr": [0, 3, 5], "region": [0, 1, 3, 4, 5], "resolv": 0, "direct": 0, "longer": 0, "ha": [0, 5], "been": [0, 1, 5], "output": [0, 3, 4, 5], "To": [0, 1, 2, 3, 5], "measur": 0, "increas": 0, "decreas": 0, "trend": [0, 1], "we": [0, 1, 2], "recommend": 0, "implement": 0, "own": [0, 5], "method": [0, 3, 4, 5], "base": [0, 1, 5], "applic": 0, "": [0, 1, 4, 5], "specif": [0, 1, 5], "need": [0, 1, 2, 5], "fips_to_abbr": [0, 5], "abbr_to_fip": [0, 5], "convert": [0, 1, 5], "between": [0, 1, 3, 4, 5], "state": [0, 1, 3, 4], "fip": [0, 1, 4, 5], "code": [0, 1, 2, 3, 4, 5], "abbrevi": [0, 1, 5], "bubbl": [0, 3, 4], "argument": [0, 1, 3, 4, 5], "plot_typ": [0, 3, 4], "fips_to_nam": [0, 1, 5], "cbsa_to_nam": [0, 5], "abbr_to_nam": [0, 5], "provid": [0, 1, 2, 3, 4, 5], "cbsa": [0, 1], "id": [0, 1, 5], "two": [0, 1, 4, 5], "letter": [0, 1, 5], "counti": [0, 1, 3, 4], "name": [0, 1, 3, 4, 5], "msa": [0, 3, 4, 5], "respect": [0, 1, 5], "name_to_fip": [0, 1, 5], "name_to_cbsa": [0, 1, 5], "human": [0, 1, 5], "readabl": [0, 1, 5], "anim": [0, 2], "take": [0, 4, 5], "datafram": [0, 3, 4, 5], "return": [0, 1, 3, 4, 5], "gener": [0, 4], "video": [0, 3, 4], "over": [0, 1, 2, 5], "time": [0, 1, 2, 5], "plot_choropleth": 0, "hrr": [0, 3, 4, 5], "addit": [0, 1, 3], "aggregate_sign": [0, 1, 5], "shift": [0, 5], "combin": [0, 1, 5], "multipl": [0, 1, 4, 5], "singl": [0, 1, 3, 4, 5], "conveni": [0, 1, 5], "comparison": 0, "across": [0, 5], "The": [0, 1, 2, 3, 4, 5], "time_valu": [0, 1, 3, 4, 5], "accept": [0, 4], "datetim": [0, 1, 3, 5], "date": [0, 1, 3, 4, 5], "object": [0, 3, 4, 5], "instead": [0, 5], "onli": [0, 1, 3, 4, 5], "panda": [0, 4, 5], "timestamp": [0, 5], "duplic": 0, "valu": [0, 1, 3, 4, 5], "geo_valu": [0, 1, 3, 4, 5], "deprec": 0, "get_geo_df": [0, 3, 4], "add": 0, "map": [0, 1, 2, 3], "capabl": 0, "data": [0, 1, 2, 3, 4], "see": [0, 1, 2, 3, 4, 5], "document": [0, 1, 2, 3, 4, 5], "exampl": [0, 2, 4, 5], "more": [0, 1, 2, 3, 4, 5], "detail": [0, 1, 2, 3, 4, 5], "as_of": [0, 1, 5], "lag": [0, 1, 3, 5], "wa": [0, 1, 5], "certain": [0, 1], "default": [0, 1, 2, 3, 4, 5], "behavior": 0, "most": [0, 1, 3, 4, 5], "up": [0, 5], "match": [0, 1, 4, 5], "previou": [0, 5], "user": [0, 1, 2, 4, 5], "prior": [0, 1], "desir": [0, 1, 3, 4, 5], "frame": [0, 1, 3, 4, 5], "all": [0, 1, 2, 3, 4, 5], "sourc": [0, 1, 2, 3, 4, 5], "about": [0, 1, 4], "each": [0, 1, 3, 4, 5], "minor": 0, "chang": [0, 1, 5], "includ": [0, 1, 2, 5], "geographi": [0, 2, 3, 4, 5], "rather": [0, 1, 2], "than": [0, 1, 2, 5], "improv": 0, "first": [0, 1, 4, 5], "public": [0, 2], "usabl": 0, "releas": 0, "access": [1, 2, 5], "numer": 1, "covid": [1, 2, 3], "relat": [1, 2], "stream": [1, 5], "daili": [1, 2, 3, 5], "live": 1, "server": [1, 2], "make": [1, 2], "store": [1, 2, 3], "within": 1, "itself": 1, "mean": [1, 4, 5], "receiv": 1, "latest": 1, "If": [1, 2, 3, 4, 5], "conduct": [1, 4, 5], "analysi": [1, 5], "power": [1, 2], "servic": [1, 2], "repeat": 1, "same": [1, 5], "download": [1, 2, 5], "pypi": 1, "pip": 1, "favorit": 1, "manag": 1, "well": [1, 4], "list": [1, 2, 4, 5], "mani": [1, 5], "shown": 1, "interact": [1, 2], "come": 1, "varieti": [1, 2], "cover": 1, "inform": [1, 2, 3, 4, 5], "offici": 1, "case": [1, 2, 3, 5], "count": 1, "internet": 1, "search": 1, "encount": 1, "survei": [1, 2, 3, 5], "respons": 1, "below": [1, 4], "brief": 1, "full": 1, "descript": [1, 5], "healthcar": [1, 2], "outpati": 1, "visit": 1, "diagnost": 1, "de": 1, "identifi": [0, 1, 2, 4], "medic": 1, "claim": 1, "doctor": 1, "symptom": [1, 2], "googl": 1, "health": 1, "volum": [1, 2], "admiss": 1, "associ": [1, 5], "diagnos": 1, "indic": [1, 5], "aggreg": [1, 5], "other": [1, 2, 4, 5], "activ": 1, "jhu": 1, "death": [1, 2], "confirm": [1, 5], "report": [1, 3, 5], "made": 1, "john": 1, "hopkin": 1, "univers": [1, 2], "quidel": 1, "posit": 1, "antigen": 1, "test": 1, "safegraph": 1, "mobil": 1, "movement": 1, "phone": 1, "locat": [1, 4, 5], "variou": [1, 3], "cmu": [1, 5], "usafact": 1, "specifi": [1, 3, 5], "page": 1, "For": [1, 2, 3, 4, 5], "obtain": [1, 5], "raw": 1, "topic": 1, "would": [1, 5], "ght": 1, "raw_search": 1, "These": [1, 3, 4, 5], "smooth": 1, "estim": [1, 3, 5], "like": [1, 3, 5], "ill": 1, "our": [1, 2, 3, 5], "distribut": 1, "through": [1, 2], "facebook": 1, "everi": [1, 2, 4, 5], "unit": [1, 5], "2020": [1, 2, 3], "05": 1, "01": [1, 3], "07": 1, "import": [1, 3], "fb": [1, 3, 5], "smoothed_cli": [1, 3, 5], "5": [1, 2, 3, 4, 5], "1": [1, 2, 3, 4, 5], "7": [1, 2, 3], "head": 1, "sample_s": [1, 3, 5], "stderr": [1, 3, 5], "0": [1, 2, 3, 4], "01000": [1, 3], "23": [1, 2], "22": [1, 2], "1722": 1, "4551": 1, "125573": 1, "823080": 1, "01001": [1, 3], "115": [1, 3], "8025": 1, "800444": 1, "261261": 1, "2": [1, 2, 3, 5], "01003": [1, 3], "584": 1, "3194": 1, "308680": 1, "665129": 1, "3": [1, 2, 3, 4, 5], "01015": [1, 3], "122": [1, 3], "5577": 1, "526590": 1, "574713": 1, "4": [1, 2, 3], "01031": 1, "114": 1, "8318": 1, "347450": 1, "408163": 1, "row": [1, 3, 4, 5], "repres": [1, 3, 5], "one": [1, 3, 4, 5], "observ": [1, 4, 5], "dai": [1, 4, 5], "given": [1, 4, 5], "column": [1, 3, 4, 5], "here": [1, 5], "percentag": 1, "peopl": 1, "its": [1, 4, 5], "standard": [1, 4, 5], "mai": [1, 2, 5], "1st": 1, "were": 1, "23rd": 1, "give": [1, 5], "By": [1, 2, 3, 4, 5], "submit": [1, 2], "anonym": [1, 2, 5], "have": [1, 3, 4, 5], "normal": 1, "your_api_kei": 1, "technic": 1, "calcul": [1, 5], "In": [1, 5], "explain": 1, "definit": 1, "exact": [1, 5], "text": 1, "describ": [1, 5], "mathemat": 1, "deriv": 1, "also": [1, 2, 3, 4, 5], "after": [1, 4, 5], "sinc": [1, 3], "ak": 1, "1606": 1, "0000": 1, "158880": 1, "460772": 1, "al": 1, "7540": 1, "2437": 1, "082553": 1, "699511": 1, "4921": 1, "4827": 1, "103651": 1, "759798": 1, "az": 1, "11220": 1, "9587": 1, "061794": 1, "566937": 1, "ca": [1, 3], "51870": 1, "1382": 1, "022803": 1, "364908": 1, "pennsylvania": 1, "month": [1, 3], "pa_data": 1, "31": [1, 3], "pa": 1, "31576": 1, "0165": 1, "030764": 1, "400011": 1, "21": [1, 3], "31344": 1, "0168": 1, "030708": 1, "02": 1, "394774": 1, "20": 1, "30620": 1, "0162": 1, "031173": 1, "03": 1, "396340": 1, "19": [1, 2], "30419": 1, "0163": 1, "029836": 1, "04": [1, 3], "357501": 1, "18": 1, "29245": 1, "0172": 1, "030176": 1, "354521": 1, "ny": 1, "mo": 1, "sometim": [1, 5], "join": [1, 3, 4, 5], "suppos": 1, "d": 1, "look": [1, 5], "relationship": 1, "number": [1, 5], "three": 1, "later": [1, 5], "option": [1, 4, 5], "follow": [1, 3, 5], "confirmed_incidence_num": 1, "deaths_incidence_num": 1, "cases_v_death": 1, "dt": [1, 5], "renam": 1, "combination_confirmed_incidence_num_0_valu": 1, "combination_deaths_incidence_num_1_valu": 1, "nan": [1, 3], "62": 1, "65": 1, "24": [1, 2, 3], "1209": 1, "13": [1, 3], "1332": 1, "547": 1, "result": [1, 5], "contain": [1, 3, 4, 5], "per": [1, 3, 4, 5], "abov": [1, 4], "becaus": 1, "input": [1, 3, 4, 5], "did": 1, "late": 1, "april": 1, "note": [1, 2, 3, 5], "long": 1, "prevent": 1, "ambigu": 1, "collis": 1, "record": [1, 5], "just": 1, "consid": [1, 2, 5], "That": 1, "delai": 1, "being": 1, "due": [1, 5], "taken": 1, "ingest": [1, 5], "could": 1, "perhap": 1, "arriv": 1, "constitut": 1, "recent": [1, 4, 5], "best": 1, "who": 1, "simpli": [1, 3], "want": 1, "graph": 1, "construct": 1, "dashboard": [1, 2], "But": 1, "interest": [1, 4, 5], "know": 1, "start_dai": [1, 5], "end_dai": [1, 5], "6": [1, 2, 3, 4, 5], "none": [1, 3, 4, 5], "32192": 1, "show": [1, 3], "don": 1, "t": 1, "64": 1, "075015": 1, "substanti": 1, "reflect": 1, "becam": [1, 5], "occur": 1, "illustr": 1, "particularli": 1, "forecast": 1, "task": 1, "backtest": 1, "model": [1, 5], "past": 1, "much": 1, "period": 1, "15": 1, "693061": 1, "06": [1, 3], "524167": 1, "321920": 1, "08": [1, 3], "897032": 1, "09": 1, "8": [1, 2, 3, 4], "956456": 1, "12": [1, 4, 5], "11": [1, 2], "190634": 1, "220023": 1, "14": 1, "231314": 1, "239970": 1, "clearli": 1, "never": [1, 5], "among": 1, "final": [1, 5], "correspond": [1, 3, 4, 5], "802238": 1, "483125": 1, "968670": 1, "400255": 1, "though": [1, 5], "3rd": [1, 5], "4th": 1, "set": [1, 5], "10th": 1, "fact": [1, 5], "9": [1, 2], "749537": 1, "989626": 1, "10": [1, 2], "006860": 1, "970561": 1, "038054": 1, "As": [1, 2, 3], "seen": 1, "uniqu": [1, 5], "except": 1, "geograph": [1, 2, 3, 4], "find": 1, "houston": 1, "san": 1, "antonio": 1, "26420": 1, "41700": 1, "quickli": [1, 5], "allegheni": 1, "lo": 1, "angel": 1, "miami": 1, "dade": 1, "df": [1, 3], "data_sourc": [1, 3, 5], "42003": 1, "336086": 1, "06037": 1, "787655": 1, "12086": 1, "405477": 1, "back": 1, "regular": [1, 5], "express": [1, 5], "meet": 1, "criteria": 1, "five": 1, "digit": [1, 4, 5], "begin": [1, 5], "42": [1, 3], "pa_counti": 1, "ties_method": [1, 5], "42000": 1, "42001": 1, "adam": 1, "42005": 1, "armstrong": 1, "42007": 1, "beaver": 1, "42009": 1, "bedford": 1, "42011": 1, "berk": 1, "42013": 1, "blair": 1, "42015": 1, "bradford": 1, "42017": 1, "buck": 1, "42019": 1, "butler": 1, "42021": 1, "cambria": 1, "42023": 1, "cameron": 1, "42025": 1, "carbon": 1, "42027": 1, "centr": 1, "42029": 1, "chester": 1, "42031": 1, "clarion": 1, "42033": 1, "clearfield": 1, "42035": 1, "clinton": 1, "42037": 1, "columbia": 1, "42039": 1, "crawford": 1, "42041": 1, "cumberland": 1, "42043": 1, "dauphin": 1, "42045": 1, "delawar": 1, "42047": 1, "elk": 1, "42049": 1, "eri": 1, "42051": 1, "fayett": 1, "42053": 1, "forest": 1, "42055": 1, "franklin": 1, "42057": 1, "fulton": 1, "42059": 1, "green": 1, "42061": 1, "huntingdon": 1, "42063": 1, "indiana": 1, "42065": 1, "jefferson": 1, "42067": 1, "juniata": 1, "42069": 1, "lackawanna": 1, "42071": 1, "lancast": 1, "42073": 1, "lawrenc": 1, "42075": 1, "lebanon": 1, "42077": 1, "lehigh": 1, "42079": 1, "luzern": 1, "42081": 1, "lycom": 1, "42083": 1, "mckean": 1, "42085": 1, "mercer": 1, "42087": 1, "mifflin": 1, "42089": 1, "monro": 1, "42091": 1, "montgomeri": 1, "42093": 1, "montour": 1, "42095": 1, "northampton": 1, "42097": 1, "northumberland": 1, "42099": 1, "perri": 1, "42101": 1, "philadelphia": 1, "42103": 1, "pike": 1, "42105": 1, "potter": 1, "42107": 1, "schuylkil": 1, "42109": 1, "snyder": 1, "42111": 1, "somerset": 1, "42113": 1, "sullivan": 1, "42115": 1, "susquehanna": 1, "42117": 1, "tioga": 1, "42119": 1, "union": [1, 4, 5], "42121": 1, "venango": 1, "42123": 1, "warren": 1, "42125": 1, "washington": 1, "42127": 1, "wayn": 1, "42129": 1, "westmoreland": 1, "42131": 1, "wyom": 1, "42133": 1, "york": 1, "work": [1, 2], "publish": [2, 5], "group": [2, 5], "carnegi": 2, "mellon": 2, "rang": [2, 5], "collect": [2, 5], "licens": 2, "cite": 2, "tracker": 2, "found": [2, 4, 5], "github": 2, "get": [2, 5], "start": [2, 5], "check": 2, "out": 2, "should": 2, "subscrib": 2, "mail": 2, "notifi": 2, "compat": [0, 2], "some": [2, 5], "limit": [2, 5], "do": [2, 3, 4], "appli": [2, 5], "research": 2, "resourc": 2, "cannot": 2, "high": 2, "without": [2, 4, 5], "product": 2, "app": 2, "central": 2, "term": 2, "warrant": 2, "particular": 2, "purpos": [2, 4], "overview": 2, "basic": 2, "track": [2, 5], "deal": [2, 5], "built": 2, "further": [2, 5], "custom": [2, 4], "refer": 2, "choropleth": [2, 3], "creat": [2, 3, 5], "geodatafram": [2, 3], "changelog": 2, "v0": 2, "octob": 2, "2023": 2, "june": [2, 5], "2021": 2, "februari": 2, "januari": 2, "decemb": 2, "novemb": 2, "august": [2, 3], "30": [2, 3], "juli": 2, "26": 2, "29": 2, "current": [3, 4, 5], "type": [3, 4, 5], "color": [3, 4], "polygon": [3, 4], "megacounti": [3, 4], "insuffici": 3, "sampl": [3, 5], "size": [3, 5], "matplotlib": [3, 4], "pyplot": 3, "plt": 3, "png": 3, "hire": 3, "pdf": 3, "present": [3, 4], "light": 3, "grei": 3, "demonstr": 3, "altern": 3, "keyword": [3, 4], "geopanda": [3, 4], "cmap": 3, "viridi": 3, "edgecolor": 3, "figur": [3, 4], "alter": 3, "fig": 3, "set_dpi": 3, "100": 3, "pass": [3, 4], "mp4": 3, "file": [3, 4], "test_plot": 3, "browser": 3, "doe": 3, "html5": 3, "element": 3, "format": [3, 4, 5], "rate": [3, 4, 5], "resolut": [3, 5], "adjust": 3, "static": 3, "test_plot2": 3, "fp": [3, 4], "control": [3, 4], "relev": 3, "polgon": 3, "tool": 3, "geometri": [3, 4], "2019": [3, 4], "censu": [3, 4], "cartograph": [3, 4], "boundari": [3, 4], "differ": [3, 4, 5], "try": 3, "comput": 3, "right": [3, 4], "left": [3, 4], "side": [3, 4], "so": [3, 4, 5], "possibl": 3, "fill": 3, "those": [3, 4], "inherit": 3, "sing": 3, "combine_megacounti": [3, 4], "true": [3, 4, 5], "oper": 3, "must": [3, 4, 5], "anoth": 3, "join_typ": [3, 4, 5], "state_fip": [3, 4], "24510": 3, "375601": 3, "193356": 3, "587": 3, "6289": 3, "76": 3, "71131": 3, "39": 3, "37193": 3, "62619": 3, "372": 3, "31169": 3, "928208": 3, "168783": 3, "1059": 3, "8130": 3, "97": 3, "82082": 3, "40": 3, "35054": 3, "36869": 3, "350": 3, "37077": 3, "627742": 3, "081884": 3, "3146": 3, "0176": 3, "78": 3, "80252": 3, "36": 3, "21349": 3, "80235": 3, "220": 3, "37": 3, "46091": 3, "589745": 3, "161989": 3, "778": 3, "7429": 3, "97924": 3, "45": 3, "76257": 3, "97878": 3, "935": 3, "46": 3, "39075": 3, "785641": 3, "099959": 3, "2767": 3, "5054": 3, "82": 3, "22066": 3, "66758": 3, "12620": 3, "668": 3, "3228": 3, "53055": 3, "440817": 3, "143404": 3, "944": 3, "1731": 3, "multipolygon": 3, "97714": 3, "48": 3, "79345": 3, "9379": 3, "53": 3, "3229": 3, "39133": 3, "040082": 3, "089324": 3, "310": 3, "8495": 3, "81": 3, "39328": 3, "41": 3, "02544": 3, "39322": 3, "040": 3, "3230": 3, "08025": 3, "440306": 3, "123763": 3, "1171": 3, "5823": 3, "104": 3, "05840": 3, "38": 3, "26084": 3, "05392": 3, "3231": 3, "13227": 3, "009511": 3, "092993": 3, "3605": 3, "8731": 3, "84": 3, "65437": 3, "34": 3, "54895": 3, "52139": 3, "550": 3, "3232": 3, "21145": 3, "257862": 3, "915558": 3, "150": [3, 4], "4266": 3, "88": 3, "93308": 3, "22775": 3, "93174": 3, "227": 3, "3233": 3, "x": 3, "153447": 3, "136070": 3, "1759": 3, "8539": 3, "539568": 3, "450588": 3, "107": 3, "9345": 3, "86": 3, "91759": 3, "32": 3, "66417": 3, "81657": 3, "660": 3, "625496": 3, "522036": 3, "455": 3, "2964": 3, "02927": 3, "22271": 3, "02399": 3, "230": 3, "000000": 3, "378788": 3, "2302": 3, "14371": 3, "33": 3, "70913": 3, "12388": 3, "710": 3, "01051": 3, "786565": 3, "435877": 3, "112": 3, "5569": 3, "41333": 3, "75059": 3, "37497": 3, "753": 3, "840": 3, "55141": 3, "190476": 3, "867751": 3, "144": 3, "3682": 3, "90": 3, "31605": 3, "44": 3, "42450": 3, "31596": 3, "424": 3, "55": 3, "841": 3, "56000": 3, "822092": 3, "254670": 3, "628": 3, "9937": 3, "842": 3, "56021": 3, "269360": 3, "315094": 3, "197": 3, "9646": 3, "105": 3, "28064": 3, "33100": 3, "27824": 3, "56": 3, "843": 3, "56025": 3, "170940": 3, "304654": 3, "192": 3, "0237": 3, "54353": 3, "78156": 3, "50142": 3, "844": 3, "72000": 3, "228310": 3, "9990": 3, "845": 3, "With": 3, "point": 3, "whatev": 3, "style": 3, "prefer": 3, "california": 3, "mercat": 3, "project": [3, 4], "geo_data": 3, "loc": 3, "to_cr": 3, "epsg": 3, "3395": 3, "true_valu": 3, "figsiz": 3, "legend": 3, "axi": 3, "off": 3, "underneath": 4, "kwarg": 4, "esri": 4, "102003": 4, "usa": [4, 5], "contigu": 4, "alber": 4, "equal": 4, "conic": 4, "puerto": 4, "rico": 4, "102006": 4, "alaska": 4, "102007": 4, "hawaii": 4, "visual": 4, "move": 4, "lower": 4, "corner": 4, "closer": 4, "florida": 4, "colormap": 4, "ylorrd": 4, "scale": 4, "histor": 4, "deviat": [4, 5], "customiz": 4, "purpl": 4, "discret": 4, "bin": 4, "displai": 4, "white": 4, "std": 4, "dev": 4, "highest": 4, "paramet": [4, 5], "bool": [4, 5], "oppos": 4, "ani": [4, 5], "str": [4, 5], "either": [4, 5], "filepath": 4, "dpi": 4, "form": 4, "imageio": 4, "ffmpeg": 4, "path": 4, "save": 4, "filenam": 4, "extens": 4, "int": [4, 5], "second": 4, "dot": 4, "inch": 4, "8x9": 4, "1920x1440": 4, "append": [4, 5], "geo_value_col": 4, "geo_type_col": 4, "fals": [4, 5], "augment": 4, "shape": 4, "build": [4, 5], "cm": 4, "geo": 4, "them": [4, 5], "alwai": 4, "regardless": [4, 5], "whether": [4, 5], "outer": [4, 5], "inner": 4, "select": [4, 5], "constitu": 4, "000": [4, 5], "websit": 4, "along": 4, "span": 4, "gc": 4, "nad83": 4, "coordin": 4, "system": 4, "wgs84": 4, "subsequ": 5, "string": [0, 5], "anyon": 5, "maximum": 5, "etc": 5, "exempt": 5, "regist": 5, "http": 5, "edu": 5, "admin": 5, "registration_form": 5, "polici": 5, "5th": 5, "onc": 5, "becom": 5, "revis": 5, "8th": 5, "allow": 5, "mutual": 5, "exclus": 5, "prioriti": 5, "initi": 5, "ask": 5, "6th": 5, "enforc": 5, "beyond": 5, "truncat": 5, "suffici": 5, "automat": 5, "split": 5, "howev": 5, "warn": 5, "discuss": 5, "round": 5, "epiweek": 5, "e": 5, "sundai": 5, "inclus": 5, "iter": 5, "tupl": 5, "end": 5, "There": 5, "sever": 5, "integ": 5, "exactli": 5, "tempor": 5, "mmwr": 5, "downstream": 5, "recogn": 5, "might": 5, "quantiti": 5, "confirmed_cumulative_num": 5, "cumul": 5, "privaci": 5, "constraint": 5, "pars": 5, "correctli": 5, "part": 5, "produc": 5, "index": 5, "front": 5, "separ": 5, "underscor": 5, "g": 5, "source_signal_0_inputcolumn": 5, "origin": 5, "drop": 5, "forward": 5, "jan": 5, "length": 5, "done": 5, "least": 5, "surveil": 5, "publicli": 5, "hss": 5, "henc": 5, "min_tim": 5, "max_tim": 5, "num_loc": 5, "distinct": 5, "ever": 5, "min_valu": 5, "smallest": 5, "max_valu": 5, "largest": 5, "mean_valu": 5, "arithmet": 5, "stdev_valu": 5, "last_upd": 5, "utc": 5, "last": 5, "max_issu": 5, "min_lag": 5, "max_lag": 5, "while": 5, "ignore_cas": 5, "individu": 5, "boolean": 5, "insensit": 5, "ignor": 5, "sensit": 5, "determin": 5, "dict": 5, "restrict": 5, "abbr": 5, "name_to_abbr": 5, "12000": 5, "agent": 0, "mark": [], "_async_fetch_epidata": 0, "web": 0, "themselv": 0, "newer": 0, "libarari": 0, "endpoint": 0, "privat": 0}, "objects": {"covidcast": [[5, 0, 1, "", "abbr_to_fips"], [5, 0, 1, "", "abbr_to_name"], [5, 0, 1, "", "aggregate_signals"], [4, 0, 1, "", "animate"], [5, 0, 1, "", "cbsa_to_name"], [5, 0, 1, "", "fips_to_abbr"], [5, 0, 1, "", "fips_to_name"], [4, 0, 1, "", "get_geo_df"], [5, 0, 1, "", "metadata"], [5, 0, 1, "", "name_to_abbr"], [5, 0, 1, "", "name_to_cbsa"], [5, 0, 1, "", "name_to_fips"], [4, 0, 1, "", "plot"], [5, 0, 1, "", "signal"], [5, 0, 1, "", "use_api_key"]]}, "objtypes": {"0": "py:function"}, "objnames": {"0": ["py", "function", "Python function"]}, "titleterms": {"changelog": 0, "v0": 0, "2": 0, "octob": 0, "10": 0, "2023": 0, "1": 0, "june": 0, "0": 0, "mai": 0, "23": 0, "5": 0, "11": 0, "2021": 0, "4": 0, "februari": 0, "24": 0, "3": 0, "januari": 0, "decemb": 0, "2020": 0, "novemb": 0, "22": 0, "9": 0, "august": 0, "30": 0, "8": 0, "juli": 0, "26": 0, "7": 0, "29": 0, "6": 0, "19": 0, "get": 1, "start": 1, "overview": 1, "instal": 1, "signal": [1, 4, 5], "basic": 1, "exampl": [1, 3], "track": 1, "issu": 1, "updat": 1, "deal": 1, "geographi": 1, "covidcast": 2, "api": [2, 5], "client": 2, "content": 2, "plot": [3, 4], "built": 3, "function": 3, "anim": [3, 4], "further": 3, "custom": 3, "refer": 4, "choropleth": 4, "map": 4, "over": 4, "time": 4, "creat": 4, "geodatafram": 4, "fetch": 5, "data": 5, "kei": 5, "metadata": 5, "work": 5, "geograph": 5, "identifi": 5, "counti": 5, "metropolitan": 5, "statist": 5, "area": 5, "state": 5}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Getting Started": [[1, "getting-started"]], "Overview": [[1, "overview"]], "Installation": [[1, "installation"]], "Signal Overview": [[1, "signal-overview"]], "Basic examples": [[1, "basic-examples"]], "Tracking issues and updates": [[1, "tracking-issues-and-updates"]], "Dealing with geographies": [[1, "dealing-with-geographies"]], "COVIDcast API client": [[2, "covidcast-api-client"]], "Contents": [[2, "contents"]], "Plotting Examples": [[3, "plotting-examples"]], "Built-in functionality": [[3, "built-in-functionality"]], "Animations": [[3, "animations"]], "Further customization": [[3, "further-customization"]], "Plotting Reference": [[4, "plotting-reference"]], "Choropleth maps": [[4, "choropleth-maps"]], "Animate a signal over time": [[4, "animate-a-signal-over-time"]], "Creating a GeoDataFrame": [[4, "creating-a-geodataframe"]], "Fetching Data": [[5, "fetching-data"]], "API keys": [[5, "api-keys"]], "Signals": [[5, "signals"]], "Metadata": [[5, "metadata"]], "Working with geographic identifiers": [[5, "working-with-geographic-identifiers"]], "Counties": [[5, "counties"]], "Metropolitan statistical areas": [[5, "metropolitan-statistical-areas"]], "States": [[5, "states"]], "Changelog": [[0, "changelog"]], "v0.2.2, October 10, 2023": [[0, "v0-2-2-october-10-2023"]], "v0.2.1, June 1, 2023": [[0, "v0-2-1-june-1-2023"]], "v0.2.0, May 23, 2023": [[0, "v0-2-0-may-23-2023"]], "v0.1.5, May 11, 2021": [[0, "v0-1-5-may-11-2021"]], "v0.1.4, February 24, 2021": [[0, "v0-1-4-february-24-2021"]], "v0.1.3, January 5, 2021": [[0, "v0-1-3-january-5-2021"]], "v0.1.2, December 10, 2020": [[0, "v0-1-2-december-10-2020"]], "v0.1.1, November 22, 2020": [[0, "v0-1-1-november-22-2020"]], "v0.1.0, October 1, 2020": [[0, "v0-1-0-october-1-2020"]], "v0.0.9, August 30, 2020": [[0, "v0-0-9-august-30-2020"]], "v0.0.8, July 26, 2020": [[0, "v0-0-8-july-26-2020"]], "v0.0.7, June 29, 2020": [[0, "v0-0-7-june-29-2020"]], "v0.0.6, June 22, 2020": [[0, "v0-0-6-june-22-2020"]], "v0.0.5, June 19, 2020": [[0, "v0-0-5-june-19-2020"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/docs/covidcast-py/html/signals.html b/docs/covidcast-py/html/signals.html index ac891154..9d3efd8a 100644 --- a/docs/covidcast-py/html/signals.html +++ b/docs/covidcast-py/html/signals.html @@ -1,17 +1,17 @@ - + - - - Fetching Data — COVIDcast API client 0.2.1 documentation - - - - - - + + + Fetching Data — COVIDcast API client 0.2.2 documentation + + + + + + @@ -33,12 +33,12 @@
          -

          Fetching Data

          +

          Fetching Data

          -

          API keys

          +

          API keys

          -covidcast.use_api_key(key)
          +covidcast.use_api_key(key)

          Set the API key to use for all subsequent queries.

          Parameters:
          @@ -57,12 +57,12 @@

          API keys -

          Signals

          +

          Signals

          This package provides a key function to obtain any signal of interest as a Pandas data frame. Detailed examples are provided in the usage examples.

          -covidcast.signal(data_source, signal, start_day=None, end_day=None, geo_type='county', geo_values='*', as_of=None, issues=None, lag=None, time_type='day')
          +covidcast.signal(data_source, signal, start_day=None, end_day=None, geo_type='county', geo_values='*', as_of=None, issues=None, lag=None, time_type='day')

          Download a Pandas data frame for one signal.

          Obtains data for selected date ranges for all geographic regions of the United States. Available data sources and signals are documented in the @@ -104,11 +104,11 @@

          Signals"fb-survey".

        • signal (str) – String identifying the signal from that source to query, such as "smoothed_cli".

        • -
        • start_day (Optional[date]) – Query data beginning on this date. Provided as a +

        • start_day (date) – Query data beginning on this date. Provided as a datetime.date object. If start_day is None, defaults to the first day data is available for this signal. If time_type == "week", then this is rounded to the epiweek containing the day (i.e. the previous Sunday).

        • -
        • end_day (Optional[date]) – Query data up to this date, inclusive. Provided as a +

        • end_day (date) – Query data up to this date, inclusive. Provided as a datetime.date object. If end_day is None, defaults to the most recent day data is available for this signal. If time_type == "week", then this is rounded to the epiweek containing the day (i.e. the previous Sunday).

        • @@ -119,11 +119,11 @@

          SignalsOptional[date]) – Fetch only data that was available on or before this date, +
        • as_of (date) – Fetch only data that was available on or before this date, provided as a datetime.date object. If None, the default, return the most recent available data. If time_type == "week", then this is rounded to the epiweek containing the day (i.e. the previous Sunday).

        • -
        • issues (Union[date, Tuple[date], List[date], None]) – Fetch only data that was published or updated (“issued”) on +

        • issues (Union[date, Tuple[date], List[date]]) – Fetch only data that was published or updated (“issued”) on these dates. Provided as either a single datetime.date object, indicating a single date to fetch data issued on, or a tuple or list specifying (start, end) dates. In this case, return all data issued in @@ -131,7 +131,7 @@

          SignalsNone, the default, return the most recently issued data. If time_type == "week", then these are rounded to the epiweek containing the day (i.e. the previous Sunday).

        • -
        • lag (Optional[int]) – Integer. If, for example, lag=3, fetch only data that was +

        • lag (int) – Integer. If, for example, lag=3, fetch only data that was published or updated exactly 3 days after the date. For example, a row with time_value of June 3 will only be included in the results if its data was issued or updated on June 6. If None, the default, return the @@ -200,7 +200,7 @@

          Signals
          -covidcast.aggregate_signals(signals, dt=None, join_type='outer')
          +covidcast.aggregate_signals(signals, dt=None, join_type='outer')

          Given a list of DataFrames, [optionally] lag each one and join them into one DataFrame.

          This method takes a list of DataFrames containing signal information for geographic regions across time, and outputs a single DataFrame with a column @@ -218,7 +218,7 @@

          SignalsParameters:
          Return type:
          @@ -380,10 +380,10 @@

          Counties -

          Metropolitan statistical areas

          +

          Metropolitan statistical areas

          -covidcast.cbsa_to_name(code, ignore_case=False, fixed=False, ties_method='first')
          +covidcast.cbsa_to_name(code, ignore_case=False, fixed=False, ties_method='first')

          Look up MSA names by codes with regular expression support.

          Given an individual or list of FIPS codes or regular expressions, look up the corresponding MSA names.

          @@ -416,7 +416,7 @@

          Metropolitan statistical areas
          -covidcast.name_to_cbsa(name, ignore_case=False, fixed=False, ties_method='first', state=None)
          +covidcast.name_to_cbsa(name, ignore_case=False, fixed=False, ties_method='first', state=None)

          Look up MSA codes by names with regular expression support.

          Given an individual or list of names or regular expressions, look up the corresponding MSA codes.

          @@ -432,7 +432,7 @@

          Metropolitan statistical areas"all" or "first". If "first", then only the first match for each code is returned. If "all", then all matches for each code are returned. Defaults to first.

        • -
        • state (Optional[str]) – 2 letter state code, case insensitive, to restrict results to.

        • +
        • state (str) – 2 letter state code, case insensitive, to restrict results to.

        Return type:
        @@ -450,10 +450,10 @@

        Metropolitan statistical areas -

        States

        +

        States

        -covidcast.abbr_to_name(abbr, ignore_case=False, fixed=False, ties_method='first')
        +covidcast.abbr_to_name(abbr, ignore_case=False, fixed=False, ties_method='first')

        Look up state name by abbreviation with regular expression support.

        Given an individual or list of state abbreviations or regular expressions, look up the corresponding state names.

        @@ -486,7 +486,7 @@

        States
        -covidcast.name_to_abbr(name, ignore_case=False, fixed=False, ties_method='first')
        +covidcast.name_to_abbr(name, ignore_case=False, fixed=False, ties_method='first')

        Look up state abbreviation by name with regular expression support.

        Given an individual or list of state names or regular expressions, look up the corresponding state abbreviations.

        @@ -520,7 +520,7 @@

        States
        -covidcast.abbr_to_fips(code, ignore_case=False, fixed=False, ties_method='first')
        +covidcast.abbr_to_fips(code, ignore_case=False, fixed=False, ties_method='first')

        Look up state FIPS codes by abbreviation with regular expression support.

        Given an individual or list of state abbreviations or regular expressions, look up the corresponding state FIPS codes. The returned codes are 5 digits: the @@ -554,7 +554,7 @@

        States
        -covidcast.fips_to_abbr(code, ignore_case=False, fixed=False, ties_method='first')
        +covidcast.fips_to_abbr(code, ignore_case=False, fixed=False, ties_method='first')

        Look up state abbreviation by FIPS codes with regular expression support.

        Given an individual or list of FIPS codes or regular expressions, look up the corresponding state abbreviation. FIPS codes can be the 2 digit code (covidcast.fips_to_abbr("12")) or @@ -667,7 +667,7 @@

        Quick search

        ©2023, Delphi research group. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.2.6 & Alabaster 0.7.13 |