read_slf: Read a Source Linkage File

In Moohan/slfhelper: Useful functions for working with the Source Linkage Files

Read a Source Linkage File

Description

Read a Source Linkage File

Usage

read_slf(
  year,
  file_version = c("episode", "individual"),
  dev = FALSE,
  col_select = NULL,
  columns = lifecycle::deprecated(),
  as_data_frame = TRUE,
  partnerships = NULL,
  recids = NULL
)

Arguments

year	Year of the file to be read, you can specify multiple years which will then be returned as one file. It will be converted to short FY using format_year().
file_version	Version of the file (individual / episode).
dev	Whether to get the file from the development area (⁠/conf/sourcedev/Source_Linkage_File_Updates⁠). The default (FALSE) will get the production file from the usual area.
col_select	A character vector of column names to keep, as in the "select" argument to data.table::fread(), or a tidy selection specification of columns, as used in dplyr::select().
columns	columns is no longer used, use col_select instead.
as_data_frame	Should the function return a tibble (default) or an Arrow Table?
partnerships	Optional specify a partnership (hscp2018) or partnerships to select.
recids	Optional specify a recid or recids to select.

Value

The requested SLF data as a tibble or an Arrow Table.

Moohan/slfhelper documentation built on April 25, 2024, 5:24 a.m.