R/project.R
project.RdSimple projections of the annual 2% samples of Australian Taxation Office tax returns.
project(sample_file, h = 0L, fy.year.of.sample.file = NULL, WEIGHT = 50L, excl_vars = NULL, forecast.dots = list(estimator = "mean", pred_interval = 80), wage.series = NULL, lf.series = NULL, use_age_pop_forecast = FALSE, .recalculate.inflators = FALSE, .copyDT = TRUE, check_fy_sample_file = TRUE, differentially_uprate_Sw = TRUE)
| sample_file | A |
|---|---|
| h | An integer. How many years should the sample file be projected? |
| fy.year.of.sample.file | The financial year of |
| WEIGHT | The sample weight for the sample file. (So a 2% file has |
| excl_vars | A character vector of column names in |
| forecast.dots | A list containing parameters to be passed to |
| wage.series | See |
| lf.series | See |
| use_age_pop_forecast | Should the inflation of the number of taxpayers be
moderated by the number of resident persons born in a certain year? If |
| .recalculate.inflators | (logical, default: |
| .copyDT | (logical, default: |
| check_fy_sample_file | (logical, default: |
| differentially_uprate_Sw | (logical, default: |
A sample file with the same number of rows as sample_file but
with inflated values as a forecast for the sample file in to_fy.
If WEIGHT is not already a column of sample_file, it will be added and its sum
will be the predicted number of taxpayers in to_fy.
Currently components of taxable income are individually inflated based on their historical trends in the ATO sample files, with the exception of:
differentially_uprate_wage.Sw_amt
wage_inflatorAlow_ben_amt, ETP_txbl_amt, Rptbl_Empr_spr_cont_amt, Non_emp_spr_amt, MCS_Emplr_Contr, MCS_Prsnl_Contr, MCS_Othr_Contr
cpi_inflatorWRE_car_amt, WRE_trvl_amt, WRE_uniform_amt, WRE_self_amt, WRE_other_amt
lf_inflator_fyWEIGHT
CG_inflatorNet_CG_amt, Tot_CY_CG_amt
Superannuation balances are inflated by a fixed rate of 5% p.a.
We recommend you use sample_file_1213 over sample_file_1314,
unless you need the superannuation variables,
as the latter suggests lower-than-recorded tax collections.
However, more recent data is of course preferable.
# install.packages('taxstats', repos = 'https://hughparsonage.github.io/drat') if (requireNamespace("taxstats", quietly = TRUE) && requireNamespace("data.table", quietly = TRUE)) { library(taxstats) library(data.table) sample_file <- copy(sample_file_1314) sample_file_1617 <- project(sample_file, h = 3L, # to "2016-17" fy.year.of.sample.file = "2013-14") }