list_geographies: DEPRECATED - List available geographies

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

DEPRECATED - List available geographies

Description

Replaced by new more powerful function, list_GeographicItems().

Usage

list_geographies(
  measure = NA,
  geo_type = NA,
  geo_type_ID = NA,
  format = "ID",
  simplified_output = TRUE,
  rollup = 0
)

Arguments

measure	Specifies the measure of interest as an ID, name, or shortName. IDs should be unquoted; name and shortName entries should be quoted strings.
geo_type	An optional argument in which you can specify a geographic type as a quoted string (e.g., "State", "County"). The "geographicType" column in the list_geography_types() output contains a list of geo_types associated with each measure.
geo_type_ID	An optional argument in which you can specify a geographic type ID as an unquoted numeric value (e.g., 1, 2). The "geographicTypeId" column in the list_geography_types() output contains a list of geo_types associated with each measure.
format	Indicates whether the measure argument contains entries formatted as an ID, name, or shortName as a quoted string (e.g., "name", "shortName"). The default is ID.
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 TRUE.
rollup	You probably won't need to change this from the default value of 0. Submitting a value of 1 returns only parent geographies (e.g., states instead of all county-level geographies). This argument does nothing if the focal geography type is already a state.

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: 
geo1_id<-list_geographies(measure=370,format="ID")

geo2_name<-
  list_geographies(measure=c("Number of summertime (May-Sep) heat-related deaths, by year"),
            format="name")

## End(Not run)

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