list_TemporalItems: List temporal items

In CDCgov/EPHTrackR: R interface to the CDC National Public Health Tracking Network

List temporal items

Description

List the temporal items (periods) available for specified measures, geography types, and geographic items.

Usage

list_TemporalItems(
  measure,
  geo_type = NA,
  simplified_output = FALSE,
  token = NULL
)

Arguments

measure	Specifies the measure of interest as an ID or name. IDs should be unquoted; name entries should be quoted strings. It is recommended that only one measure be submitted.
geo_type	An optional argument in which you can specify a geographic type as a quoted string (e.g., "State", "County") or a geographic type ID as an unquoted numeric value (e.g., 1, 2). The "geographicType" and "geographicTypeId" columns in the list_geography_types() output contain a list of potential geo_type entries associated with each measure.
simplified_output	If TRUE, a simplified output table is returned. If FALSE, the raw output from the Tracking Network Data API is returned. The default is FALSE.
token	An optional argument to submit a Tracking API token acquired from trackingsupport(AT)cdc.gov as a quoted string. It is recommended that you save your token using the tracking_api_token() function so that you don't need to enter your token when you run this function. It will be automatically pulled from you .Renviron file.

Value

This function returns a list with each element containing a data frame corresponding to each combination of the specified measures and geographic types.

Examples

## Not run: 


temp <- list_TemporalItems(measure = 99)
                          
                          
                          

## End(Not run)

CDCgov/EPHTrackR documentation built on June 6, 2024, 9:21 a.m.