NIDSS Dengue

Attribute Details
Source Name nidss_dengue
Data Source Taiwan CDC
Geographic Levels Taiwan regions and cities/counties (see Geographic Codes)
Temporal Granularity Weekly (Epiweek)
Reporting Cadence Inactive - No longer updated since 2018w10
Temporal Scope Start 2003w01
License Open Access

Overview

This is the documentation of the API for accessing the Taiwan National Infectious Disease Statistics System Dengue (nidss_dengue) endpoint of the Delphi’s epidemiological data.

General topics not specific to any particular endpoint are discussed in the API overview. Such topics include: contributing, citing, and data licensing.

Table of contents

  1. The API
    1. Parameters
      1. Required
    2. Response
  2. Example URLs
    1. NIDSS Dengue on 2015w01 (nationwide)
  3. Code Samples
    1. Legacy Clients
  4. Source and Licensing

The API

The base URL is: https://api.delphi.cmu.edu/epidata/nidss_dengue/

Parameters

Required

Parameter Description Type
epiweeks epiweeks (see Date Formats) list of epiweeks
locations locations list of Taiwan region and/or location labels (see Geographic Codes)

Response

Field Description Type
result result code: 1 = success, 2 = too many results, -2 = no results integer
epidata list of results array of objects
epidata[].location location string
epidata[].epiweek epiweek during which the data was collected integer
epidata[].count number of cases integer
message success or error message string

Example URLs

NIDSS Dengue on 2015w01 (nationwide)

https://api.delphi.cmu.edu/epidata/nidss_dengue/?locations=nationwide&epiweeks=201501

{
  "result": 1,
  "epidata": [
    {
      "location": "nationwide",
      "epiweek": 201501,
      "count": 20
    }
  ],
  "message": "success"
}

Code Samples

Libraries are available for R and Python. The following samples show how to import the library and fetch national NIDSS Dengue data for epiweeks 201501-201510 (10 weeks total).

Install the package using pip:

pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy"

# Import
from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange
# Fetch data
epidata = EpiDataContext()
res = epidata.pub_nidss_dengue(locations=['nationwide'], epiweeks=EpiRange(201501, 201510))
print(res)

library(epidatr)
# Fetch data
res <- pub_nidss_dengue(locations = 'nationwide', epiweeks = epirange(201501, 201510))
print(res)

Legacy Clients

We recommend using the modern client libraries mentioned above. Legacy clients are also available for Python, R, and JavaScript.

Optionally install the package using pip(env):

pip install delphi-epidata

Otherwise, place delphi_epidata.py from this repo next to your python script.

# Import
from delphi_epidata import Epidata
# Fetch data
res = Epidata.nidss_dengue(['nationwide'], Epidata.range(201501, 201510))
print(res['result'], res['message'], len(res['epidata']))

Source and Licensing

The full text of the NIDSS Dengue license information is available on the Taiwan Digital Development Department’s website.

Place delphi_epidata.R from this repo next to your R script.

source("delphi_epidata.R")
# Fetch data
res <- Epidata$nidss_dengue(regions = list("nationwide"), epiweeks = Epidata$range(201501, 201510))
print(res$message)
print(length(res$epidata))

<!-- Imports -->
<script src="delphi_epidata.js"></script>
<!-- Fetch data -->
<script>
  EpidataAsync.nidss_dengue('nationwide', EpidataAsync.range(201501, 201510)).then((res) => {
    console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
  });
</script>