Skip to contents

Convenience wrapper: fetch_partvii() followed by read_partvii(). Returns a raw Part VII data frame ready to pipe into standardize_df().

Usage

get_partvii(
  years,
  dest = "efdata",
  table = .partvii_table_id(),
  root = .nccs_efile_root(),
  overwrite = FALSE,
  retry_max = 3L,
  timeout = 600,
  verbose = TRUE
)

Arguments

years

Integer vector of tax years (e.g. 2023 or 2020:2023).

dest

Local cache directory. Created if it does not exist.

table

Table id (file basename). Defaults to the Part VII compensation table; exposed so the same machinery can fetch sibling tables.

root

Base URL of the efile store. Defaults to the public NCCS v2 store.

overwrite

Re-download even if the file already exists. Default FALSE.

retry_max

Number of download attempts per file. Default 3.

timeout

Per-file download timeout in seconds. Default 600.

verbose

Print progress messages. Default TRUE.

Value

A data frame with the raw Part VII schema.

Examples

if (FALSE) { # \dontrun{
df <- get_partvii( 2023 ) |> standardize_df()
} # }