get_asec: Load CPS ASEC microdata

In cpsR: Load CPS Microdata into R Using the 'Census Bureau Data' API

Load CPS ASEC microdata

Description

get_asec() loads CPS ASEC microdata using the Census API.

Usage

get_asec(
  year,
  vars,
  key = get_key(),
  show_url = FALSE,
  tibble = TRUE,
  convert = TRUE
)

Arguments

year	Year of data to retrieve. Years 1992 and on are currently supported.
vars	Character vector of variables to retrieve, where each vector element corresponds to the name of a single variable. Variable names can be given in uppercase or lowercase but are always made lowercase in the returned data.
key	Census API key. Defaults to environment variable CENSUS_API_KEY. See the README for info on how (and why) to set up env var CENSUS_API_KEY.
show_url	If TRUE, show the URL the request was sent to (with key suppressed). Defaults to FALSE.
tibble	If TRUE (default), return data as a tibble. If FALSE, return data as a base data frame.
convert	If TRUE (default), run type.convert() with as.is = TRUE on the data returned by the Census API. If FALSE, all columns in the returned data will be character vectors (exactly as returned by the Census API).

Value

A tibble or base data frame.

Examples

## Not run: 
asec21 <- get_asec(2021, vars = c("marsupwt", "spm_poor"))

## End(Not run)

cpsR documentation built on Sept. 9, 2023, 9:07 a.m.