Skip to contents

Generate ABS Derived Income data (PIT_IE)

Source: R/generate_pit_ie.R
generate_pit_ie.Rd

generate_pit_ie() writes synthetic ABS Derived Income (PIT_IE) product tables. The covered population contains people with income derived from Income Tax Return and Payment Summary data. Each record represents one person in one financial year.

Usage

generate_pit_ie(
  spine = NULL,
  seed = 42L,
  years = 2011L:2023L,
  output_dir = NULL,
  format = c("parquet", "csv"),
  return_data = FALSE
)

Arguments

spine

A data frame from generate_spine(), or NULL. If the value is NULL, the function reads the spine from the run directory.

seed

An integer random seed.

years

A vector of financial-year end years.

output_dir

The base output directory, or NULL.

format

The output format. This function supports "parquet" only.

return_data

If TRUE, the function reads each output file and returns a list of data frames.

Value

If return_data is TRUE, a named list of data frames. Otherwise, an invisible metadata list with n_rows and years.

Details

The Rust pipeline calculates each income component and writes one Parquet file for each requested financial year.

Dataset and variable information

The ABS administrative income sources website gives information about this dataset. Use dataset_info("PIT_IE") for dataset information. Use variable_info("PIT_IE") for variables, sources, value support, and topic tags.

See also

generate_pit_itr(), generate_pit_ps(), and build_fplida().