Learn R
grattan (version 1.7.1.2)

model_rent_assistance: Model Rent Assistance

Description

Model Rent Assistance

Usage

model_rent_assistance(sample_file, baseline_fy = NULL,
  baseline_Date = NULL, Per = "fortnight",
  .Prop_rent_paid_by_RA = NULL, Max_rate = NULL, Min_rent = NULL,
  calc_baseline_ra = TRUE, return. = c("sample_file", "new_ra",
  "sample_file.int"))

Arguments

sample_file

A sample file having the same variables as the data.frame in the example.

baseline_fy, baseline_Date

(character) The financial year/date over which the baseline rent assistance is to be calculated. Only one can be provided.

Per

Specifies the timeframe in which payments will be made. Can either take value "fortnight" or "annual".

.Prop_rent_paid_by_RA

The proportion of the rent above the minimum threshold paid by rent assistance.

Max_rate

If not NULL, a numeric vector indicating for each individual the maximum rent assistance payable.

Min_rent

If not NULL, a numeric vector indicating for each individual the minimum fortnightly rent above which rent assistance is payable. max_rate and min_rent

calc_baseline_ra

(logical, default: TRUE) Should the income tax in baseline_fy or baseline_Date be included as a column in the result?

return.

What should the function return? One of tax, sample_file, or sample_file.int. If tax, the tax payable under the settings; if sample_file, the sample_file, but with variables tax and possibly new_taxable_income; if sample_file.int, same as sample_file but new_tax is coerced to integer.

Examples

Run this code
# NOT RUN {
library(data.table)
sample <-
  CJ(rent = 1:500,
     n_dependants = 0:3,
     has_partner = 0:1 > 0,
     is_homeowner = 0:1 > 0,
     lives_in_sharehouse = 0:1 > 0)
model_rent_assistance(sample,
                      baseline_fy = "2018-19",
                      .Prop_rent_paid_by_RA = 0.75,
                      Max_rate = 500,
                      Min_rent = 100)
# }

Run the code above in your browser using DataCamp Workspace