Load data from the American Community Survey Public Use Microdata Series API

get_pums(
  variables = NULL,
  state = NULL,
  puma = NULL,
  year = 2019,
  survey = "acs5",
  variables_filter = NULL,
  rep_weights = NULL,
  recode = FALSE,
  show_call = FALSE,
  key = NULL
)

Arguments

variables	A vector of variables from the PUMS API. Use `View(pums_variables)` to browse variable options.
state	A state, or vector of states, for which you would like to request data. The entire US can be requested with `state = "all"` - though be patient with the data download!
puma	A vector of PUMAs from a single state, for which you would like to request data. To get data from PUMAs in more than one state, specify a named vector of state/PUMA pairs and set `state = "multiple"`.
year	The data year of the 1-year ACS sample or the endyear of the 5-year sample. Defaults to 2019.
survey	The ACS survey; one of either `"acs1"` or `"acs5"` (the default).
variables_filter	A named list of filters you'd like to return from the PUMS API. For example, passing `list(AGE = 25:50, SEX = 1)` will return only males aged 25 to 50 in your output dataset. Defaults to `NULL`, which returns all records. If a housing-only dataset is required, use `list(SPORDER = 1)` to only return householder records (taking care in your analysis to use the household weight `WGTP`).
rep_weights	Whether or not to return housing unit, person, or both housing and person-level replicate weights for calculation of standard errors; one of `"person"`, `"housing"`, or `"both"`.
recode	If TRUE, recodes variable values using Census data dictionary and creates a new `*_label` column for each variable that is recoded. Available for 2017 - 2019 data. Defaults to FALSE.
show_call	If TRUE, display call made to Census API. This can be very useful in debugging and determining if error messages returned are due to tidycensus or the Census API. Copy to the API call into a browser and see what is returned by the API directly. Defaults to FALSE.
key	Your Census API key. Obtain one at https://api.census.gov/data/key_signup.html

Value

A tibble of microdata from the ACS PUMS API.

Examples

if (FALSE) {
get_pums(variables = "AGEP", state = "VT")
get_pums(variables = "AGEP", state = "multiple", puma = c("UT" = 35008, "NV" = 00403))
get_pums(variables = c("AGEP", "ANC1P"), state = "VT", recode = TRUE)
get_pums(variables = "AGEP", state = "VT", survey = "acs1", rep_weights = "person")
}