Read in CPS data

Load multiple years of data from the Current Population Survey. This function will also download the data for you, if it is not present in the given dir.

Usage

cps_read(
  years = seq(1994, 2024, 2),
  dir = cps_data_dir(),
  cols = cpsvote::cps_cols,
  names_col = "new_name",
  join_dfs = TRUE
)

Arguments

years

Which years to read in. Thie function will read data from files in dir whose names contain these 4-digit years.

dir

The folder where the CPS data files live. These files should follow a naming scheme that contains the 4-digit year of the results in question, and have a ".zip" or ".gz" extension. Defaults to cps_data_dir(), which returns ~/cps_data unless overridden via options(cpsvote.datadir = "your/path").

cols

Which columns to read. This must be a data frame, with required columns start_pos,end_pos, and year. The default value is cps_cols, which reads from the list cpsvote::cps_cols. See vignette("add-variables") for details about how to specify a different set of cols.

names_col

The column in cols that contains column names for the specified columns. If none exists, use names_col = NULL

join_dfs

Whether to combine all of the years into a single data frame, or leave them as a list of data frames. Defaults to TRUE with a warning.

Value

a data frame, or list of data frames

Examples

if (FALSE) cps_read(years = 2016, names_col = "new_name") # \dontrun{}