list_measures: List available measures

View source: R/list_measures.R

list_measuresR Documentation

List available measures

Description

Lists the measures contained within specified indicator(s) and/or content area(s). Measures are the core data product of the Tracking Network.

Usage

list_measures(indicator = NA, content_area = NA, token = NULL)

Arguments

indicator

Optional argument used to specify the indicator(s) of interest as an ID or name. IDs should be unquoted; name entries should be quoted strings. Use list_indicators() to identify available indicators.

content_area

Optional argument used to specify the content area(s) of interest as an ID or name. IDs should be unquoted; name entries should be quoted strings. Use list_content_areas() to identify available content areas.

token

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 data frame containing the measures within the specified indicator(s) and/or content area(s).

Examples

## Not run: 

#create a comprehensive inventory of all measures and their associated indicators and content areas
full_inventory <- list_measures()

list_measures(indicator=67)

list_measures(indicator=c(67,173))

list_measures(indicator="Heat-Related Mortality")

list_measures(content_area = 25)

list_measures(indicator=67,content_area =25)

list_measures(indicator="Historical Temperature & Heat Index",content_area ="Drought")




## End(Not run)

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