Retrieve Census time-series data

Usage

tc_get_timeseries(
  geography = NULL,
  dataset,
  variables = NULL,
  table = NULL,
  time = NULL,
  year = NULL,
  within = NULL,
  predicates = NULL,
  key = tc_get_key(),
  refresh = FALSE,
  cache = TRUE,
  ucgid = NULL,
  ...
)

Arguments

geography: Optional Census geography name.
dataset: A time-series dataset identifier.
variables: Optional character vector of variable names.
table: Optional group or table identifier. Mutually exclusive with variables.
time: Optional timeseries date value, such as "2024-01".
year: Optional dataset year. Most timeseries datasets ignore this and resolve through the discovery catalog.
within: Optional named list of parent geographies.
predicates: Optional named list of filter predicates other than time.
key: Optional Census API key.
refresh: Should cached metadata be refreshed?
cache: Should discovery metadata be cached locally?
ucgid: Optional ucgid predicate.
...: Geography values such as state = "NY" or county = "001".

Value

A tibble.

Examples

if (FALSE) { # tinycensus::tc_has_key()
tc_get_timeseries(
  dataset = "intltrade/exports/hs",
  variables = "ALL_VAL_MO",
  time = "2024-01",
  predicates = list(CTY_CODE = "2010")
)
}