Merge pull request #152 from HughParsonage/CRAN-1-7

Cran 1 7

Author: HughParsonage

DESCRIPTION

@@ -2,7 +2,7 @@ Package: grattan
 Type: Package
 Title: Australian Tax Policy Analysis
 Version: 1.7.0.0
-Date: 2018-08-19
+Date: 2018-10-16
 Authors@R: c(person("Hugh", "Parsonage", role = c("aut", "cre"), email = "[email protected]"),
               person("Tim", "Cameron", role = "aut"),
               person("Brendan", "Coates", role = "aut"),

R/age_pension.R

@@ -2,7 +2,7 @@
 #' 
 #' @param fortnightly_income,annual_income Income for means-testing purposes. Provide one but not both.
 #' @param has_partner (logical, default: \code{FALSE}) Does the individual have a partner?
-#' @param n_dependants How many dependants does sthe individual have? Default is zero.
+#' @param n_dependants How many dependants does the individual have? Default is zero.
 #' @param partner_fortnightly_income,partner_annual_income The partner's income. The sum of this value and the indiviudal's income gives the income test.
 #' @param partner_pensioner (logical, default: \code{TRUE}) Is the individual's partner also in receipt of the age pension?
 #' @param Date,fy.year The financial year. Currently only 2015-16 is supported (the most recent survey of income and housing results).
@@ -14,7 +14,8 @@
 #' 
 #' @details
 #' Currently does not include the age pension supplement.
-#' @return Returns the age pension payable for each individual defined by the arguments, assuming otherwise eligible.
+#' @return Returns the age pension payable for each individual defined by the 
+#' arguments, assuming otherwise eligible.
 #' 
 #' 
 #' 

R/child_care_subsidy.R

@@ -1,23 +1,42 @@
 #' Child Care Subsidy paid per child. 
 #' 
 #' @param family_annual_income (numeric) Total income of the family.
-#' @param activity_level (numeric) The total number of activity hours of the parent. Note that if there are two parents the one with the lower activity level will be applied. Common activities include work, leave, and study. A full list can be viewed at \url{http://guides.dss.gov.au/family-assistance-guide/3/5/2/10}.
-#' @param activity_exemption (logical) Whether the parent is exempt from the activity test. Note that in a two parent family both parents must be exempt. A list of exemptions is available at \url{http://guides.dss.gov.au/family-assistance-guide/3/5/2/10}.
+#' @param activity_level (numeric) The total number of activity hours of the 
+#' parent. Note that if there are two parents the one with the lower activity 
+#' level will be applied. Common activities include work, leave, and study. A 
+#' full list can be viewed at \url{http://guides.dss.gov.au/family-assistance-guide/3/5/2/10}.
+#' @param activity_exemption (logical) Whether the parent is exempt from the 
+#' activity test. Note that in a two parent family both parents must be exempt. 
+#' A list of exemptions is available at \url{http://guides.dss.gov.au/family-assistance-guide/3/5/2/10}.
 #' @param child_age (numeric) The age of the child in child care.
-#' @param type_of_day_care (character) The type of child care. Acceptable inputs are: "cbdc" Centre Based Day Care, "oshc" Outside School Hours Care, "fdc" Family Day Care, or "ihc" In Home Care. Note that In Home Care can only be claimed once per family.
-#' @param hours_day_care_fortnight (numeric) The number of hours of day care per child per fortnight.
+#' @param type_of_day_care (character) The type of child care. Acceptable inputs
+#'  are: \code{"cbdc"} Centre Based Day Care, "oshc" Outside School Hours Care,
+#'  \code{"fdc"} Family Day Care, or 
+#'  \code{"ihc"} In Home Care. Note that In Home Care 
+#'  can only be claimed once per family.
+#' @param hours_day_care_fortnight (numeric) The number of hours of day care per
+#'  child per fortnight.
 #' @param cost_hour (numeric) The cost of day care per hour.
-#' @param early_education_program (logical) Whether the child is part of an early education program.
+#' @param early_education_program (logical) Whether the child is part of an 
+#' early education program.
 #' 
-#' @param cbdc_hourly_cap,fdc_hourly_cap,oshc_hourly_cap,ihc_hourly_cap (numeric) The lower of `cost_hour` or the relevant `hourly_cap` will be used in the calculation of the subsidy.
-#' @param annual_cap_income (numeric) The minimum family income for which the `annual_cap_subsidy` applies from.
-#' @param annual_cap_subsidy (numeric) Amount at which annual subsidies are capped for those who earn more than `annual_cap_income`. 
+#' @param cbdc_hourly_cap,fdc_hourly_cap,oshc_hourly_cap,ihc_hourly_cap (numeric) 
+#' The lower of `cost_hour` or the relevant `hourly_cap` will be used in the 
+#' calculation of the subsidy.
+#' @param annual_cap_income (numeric) The minimum family income for which the 
+#' `annual_cap_subsidy` applies from.
+#' @param annual_cap_subsidy (numeric) Amount at which annual subsidies are 
+#' capped for those who earn more than `annual_cap_income`. 
 #' 
-#' @param activity_test_1_brackets (numeric vector) The activity levels at which the activity test increases.
-#' @param activity_test_1_hours (numeric vector) The hours corresponding to the step increase in `activity_test_1_brackets`.
+#' @param activity_test_1_brackets (numeric vector) The activity levels at which
+#'  the activity test increases.
+#' @param activity_test_1_hours (numeric vector) The hours corresponding to the
+#'  step increase in `activity_test_1_brackets`.
 #' 
-#' @param income_test_bracket_1,income_test_bracket_2,income_test_bracket_3,income_test_bracket_4,income_test_bracket_5 (numeric) The steps at which income test 1 changes rates. Note the strange structure \url{https://www.humanservices.gov.au/individuals/services/centrelink/child-care-subsidy/payments/how-your-income-affects-it}.
-#' @param taper_1,taper_2,taper_3 (numeric) The proportion of the hourly cap retained. Note that the rate only decreases between each odd bracket.
+#' @param income_test_bracket_1,income_test_bracket_2,income_test_bracket_3,income_test_bracket_4,income_test_bracket_5 (numeric) The steps at which income test 1 changes rates.
+#'  Note the strange structure \url{https://www.humanservices.gov.au/individuals/services/centrelink/child-care-subsidy/payments/how-your-income-affects-it}.
+#' @param taper_1,taper_2,taper_3 (numeric) The proportion of the hourly cap 
+#' retained. Note that the rate only decreases between each odd bracket.
 #' 
 #' @return The annual child care subsidy payable per child.
 #' 

R/energy_supplement.R

@@ -1,5 +1,8 @@
 #' Energy supplement
-#' @description The ES is a supplementary payment that commenced on 20 September 2014. It was previously known as the clean energy supplement (CES). It is a fixed nominal amount; the supplement is neither indexed nor increased each year. There is no means testing.
+#' @description The energy supplement (ES) is a supplementary payment that 
+#' commenced on 20 September 2014. It was previously known as the clean energy 
+#' supplement (CES). It is a fixed nominal amount; the supplement is neither 
+#' indexed nor increased each year. There is no means testing.
 #' @param qualifying_payment A character vector designating the payment type the individual is entitled to. Valid strings are
 #' \describe{
 #' \item{pension}{All pensions and bereavement allowance}

R/family_tax_benefit.R

@@ -2,24 +2,34 @@
 #' 
 #' @param .data \code{data.table} input. Each row is an individual. 
 #' Columns must be have the same names 
-#' @param id individual id
-#' @param id_hh household id, used to group households to determine eligiblity and number of children
+#' @param id individual identifier
+#' @param id_hh household identifier, used to group households to determine eligiblity 
+#' and number of children
 #' @param age numeric: age of each \code{id}
 #' @param income numeric: income of each \code{id}
 #' @param in_secondary_school logical column: does \code{id} attend secondary school?
 #' @param single_parent logical column: is \code{id} (a parent) single?
 #' @param other_allowance_benefit_or_pension logical column: does the individual receive a pension, benefit, or labour market program payment such as Youth Allowance?
 #' @param maintenance_income numeric: the amount of maintenance income the individual receives for the care of a child/children from a previous relationship
 #' @param maintenance_children integer: the number of children in the care of \code{id} for whom \code{id} receives maintenance
-#' @param income_test_ftbA_1_bound Lower bound for which reduction in ftb A max payment occurs at rate taper_ftbA_1.
-#' @param income_test_ftbA_2_bound Lower bound for which reduction in ftb A base payment occurs at rate taper_ftbA_1.
-#' @param income_test_ftbB_bound Lower bound for which reduction in ftb B payment occurs at rate taper_ftbB.
-#' @param taper_ftbA_1 The amount at which ftb A max payment is reduced for each dollar earned above income_test_ftbA_1_bound.
-#' @param taper_ftbA_2 The amount at which ftb A base payment is reduced for each dollar earned above income_test_ftbA_2_bound.
-#' @param taper_ftbB The amount at which ftb B payment is reduced for each dollar earned above income_test_ftbB_bound.
-#' @param per How often the payment will be made. At present payments can only be annually.
-#' @param copy (logical, default: \code{TRUE}) Should a copy of \code{.data} be made before the calculation? 
-#' If \code{FALSE}, intermediate values will be assigned by reference to \code{.data} (if not \code{NULL}).
+#' @param income_test_ftbA_1_bound Lower bound for which reduction in FTB A max 
+#' payment occurs at rate \code{taper_ftbA_1}.
+#' @param income_test_ftbA_2_bound Lower bound for which reduction in FTB A base
+#'  payment occurs at rate \code{taper_ftbA_1}.
+#' @param income_test_ftbB_bound Lower bound for which reduction in FTB B payment
+#'  occurs at rate \code{taper_ftbB}.
+#' @param taper_ftbA_1 The amount at which ftb A max payment is reduced for each
+#'  dollar earned above \code{income_test_ftbA_1_bound}.
+#' @param taper_ftbA_2 The amount at which ftb A base payment is reduced for each
+#'  dollar earned above \code{income_test_ftbA_2_bound}.
+#' @param taper_ftbB The amount at which ftb B payment is reduced for each dollar
+#'  earned above \code{income_test_ftbB_bound}.
+#' @param per How often the payment will be made. At present, payments can only 
+#' be annually.
+#' @param copy (logical, default: \code{TRUE}) Should a copy of \code{.data} be 
+#' made before the calculation? 
+#' If \code{FALSE}, intermediate values will be assigned by reference to 
+#' \code{.data} (if not \code{NULL}).
 #' @author Matthew Katzen
 #' @export
 #' 

R/fy.year.R

@@ -6,7 +6,7 @@
 #' @param fy.yr A string suspected to be a financial year.
 #' @param date A string or date for which the financial year is desired. Note that \code{yr2fy} does not check its argument is an integer.
 #' @param assume1901_2100 For \code{yr2fy}, assume that \code{yr_ending} is between 1901 and 2100, 
-#' for performance. By default, set to `getOption("grattan.assume1901_2100", TRUE)`.
+#' for performance. By default, set to \code{getOption("grattan.assume1901_2100", TRUE)}.
 #' @details The following forms are permitted: \code{2012-13}, \code{201213}, \code{2012 13}, only.
 #' However, the \code{2012-13} form is preferred and will improve performance. 
 #' 

R/newstart_allowance.R

@@ -1,25 +1,36 @@
 #' Newstart allowance
 #' 
-#' @param fortnightly_income 'Ordinary income' received fortnightly within the meaning of s. 1068-G1 of the \emph{Social Security Act 1991}. 
+#' @param fortnightly_income 'Ordinary income' received fortnightly within the 
+#' meaning of s. 1068-G1 of the \emph{Social Security Act 1991}. 
 #' @param annual_income 'Ordinary income' received annually.
 #' @param has_partner Does the individual have a partner?
 #' @param partner_pensioner Does the partner receive a pension?
 #' @param n_dependants How many dependant children does the individual have?
-#' @param nine_months If the person is over 60 years old, have they been receiving payments for over 9 continuous months?
+#' @param nine_months If the person is over 60 years old, have they been 
+#' receiving payments for over 9 continuous months?
 #' @param isjspceoalfofcoahodeoc Is the recipient a single job seeker principal carer, either of large family or foster child/ren, or who is a home or distance educator of child/ren?
-#' @param principal_carer Is the individual the parent with most of the day to day care of child. Defined in https://www.humanservices.gov.au/individuals/enablers/principal-carer-rules-parenting-payment/41456
+#' @param principal_carer Is the individual the parent with most of the day-to-day
+#'  care of child. Defined in \url{https://www.humanservices.gov.au/individuals/enablers/principal-carer-rules-parenting-payment/41456}.
 #' @param fortnightly_partner_income Partner's 'Ordinary income' received fortnightly. 
 #' @param annual_partner_income Partner's Ordinary income' received annually.
 #' @param age The individual's age.
 #' @param fy.year Financial year. Default is "2015-16".
-#' @param assets_value Total value of household assets. Details can be found at https://www.humanservices.gov.au/individuals/enablers/assets/30621 
+#' @param assets_value Total value of household assets. Details can be found at
+#' \url{https://www.humanservices.gov.au/individuals/enablers/assets/30621}. 
 #' @param homeowner Is the individual a homeowner?
-#' @param taper_lower The amount at which the payment is reduced for each dollar earned between the lower and upper bounds for non-principal carers.
-#' @param taper_upper The amount at which the payment is reduced for each dollar earned above the upper bound for non-principal carers.
-#' @param taper_principal_carer The amount at which the payment is reduced for each dollar earned above the lower bound for principal carers.
-#' @param lower Lower bound for which reduction in payment occurs at rate taper_lower (taper_principal_carer for principal carers).
-#' @param upper Upper bound for which reduction in payment occurs at rate taper_lower. Lower bound for which reduction in payment occurs at rate taper_upper. Note that for principal carers there is no upper bound.
-#' @param per Specifies the timeframe in which payments will be made. Can either take value "fortnight" or "annual".
+#' @param taper_lower The amount at which the payment is reduced for each dollar
+#'  earned between the lower and upper bounds for non-principal carers.
+#' @param taper_upper The amount at which the payment is reduced for each dollar
+#'  earned above the upper bound for non-principal carers.
+#' @param taper_principal_carer The amount at which the payment is reduced for
+#'  each dollar earned above the lower bound for principal carers.
+#' @param lower Lower bound for which reduction in payment occurs at rate 
+#' \code{taper_lower} (\code{taper_principal_carer} for principal carers).
+#' @param upper Upper bound for which reduction in payment occurs at rate 
+#' \code{taper_lower}. Lower bound for which reduction in payment occurs at rate
+#' \code{taper_upper}. Note that for principal carers there is no upper bound.
+#' @param per Specifies the timeframe in which payments will be made. 
+#' Can either take value "fortnight" or "annual".
 #' @source \url{http://classic.austlii.edu.au/au/legis/cth/consol_act/ssa1991186/s1068.html}
 #' @export newstart_allowance
 

R/pension_supplement.R

@@ -12,9 +12,12 @@
 #' @param Date Date. Default is "2016/03/01" if fy.year is not present.
 #' @param fy.year Financial year. Default is "2015-16" if Date is not present.
 #' @param qualifying_payment What is the payment that the supplement is being applied to? 
-#' @param per How often the payment will be made. Default is to return the annual payment, with a messsage.
-#' @param overseas_absence Will the individual be living outside of Australia for more than 6 weeks of the upcoming year?
-#' @param seperated_couple Is the individual part of an illness separated couple, respite care couple, or partner imprisoned?
+#' @param per How often the payment will be made. Default is to return the annual
+#'  payment, with a message.
+#' @param overseas_absence Will the individual be living outside of Australia 
+#' for more than 6 weeks of the upcoming year?
+#' @param seperated_couple Is the individual part of an illness separated couple,
+#'  respite care couple, or partner imprisoned?
 #' 
 #' @author Matthew Katzen
 #' @export

R/rent_assistance.R

@@ -1,9 +1,15 @@
 #' Rent assistance
 #' @description The rent assistance to each individual payable by financial year.
-#' @param fortnightly_rent The fortnightly rent paid by each individual. By default, infinity, so the maximum rent assistance is returned by default, since rent assistance is capped at a maximum rate. Note the criteria for board and lodging which can be found at \url{http://guides.dss.gov.au/guide-social-security-law/3/8/1/70}
-#' @param per Specifies the timeframe in which payments will be made. Can either take value "fortnight" or "annual".
-#' @param fy.year (character) The financial year over which rent assistance is to be calculated.
-#' When left as \code{NULL}, defaults to the user's financial year, unless \code{max_rate} and \code{min_rent} are both set. If \code{fy.year} is set, the annual payment is provided.
+#' @param fortnightly_rent The fortnightly rent paid by each individual. By 
+#' default, infinity, so the maximum rent assistance is returned by default, 
+#' since rent assistance is capped at a maximum rate. Note the criteria for board
+#'  and lodging which can be found at \url{http://guides.dss.gov.au/guide-social-security-law/3/8/1/70}
+#' @param per Specifies the timeframe in which payments will be made. Can either
+#'  take value "fortnight" or "annual".
+#' @param fy.year (character) The financial year over which rent assistance is 
+#' to be calculated. When left as \code{NULL}, defaults to the user's financial 
+#' year, unless \code{max_rate} and \code{min_rent} are both set. If 
+#' \code{fy.year} is set, the annual payment is provided.
 #' @param Date (Date vector or coercible to such) An alternative to \code{fy.year}.
 #'  If both \code{fy.year} and \code{Date} are provided, \code{fy.year} is ignored, with a warning. 
 #'  If \code{Date} is used, the fortnightly rent assistance is provided.
@@ -17,8 +23,10 @@
 #' @param min_rent If not \code{NULL}, a numeric vector indicating for each individual the minimum fortnightly rent above which rent assistance is payable. \code{max_rate} and \code{min_rent} must not be used when \code{fy.year} is set.
 #' 
 #' @param sharers_provision_applies (logical, default: FALSE) Does the sharers provision apply to the parent payment? The list of functions can be found in table 2 column 4 \url{http://guides.dss.gov.au/guide-social-security-law/3/8/1/10}
-#' @param is_homeowner (logical, default: FALSE) Does the individual own their own home?
-#' @param lives_in_sharehouse (logical, defualt: FALSE) Does the individual live in a sharehouse?
+#' @param is_homeowner (logical, default: \code{FALSE}) Does the individual own 
+#' their own home?
+#' @param lives_in_sharehouse (logical, default: \code{FALSE}) Does the individual
+#'  live in a sharehouse?
 #' 
 #' @return If \code{fy.year} is used, the annual rent assistance payable for each individual; 
 #' if \code{Date} is used, the \emph{fortnightly} rent assistance payable.

R/validate_date.R

@@ -2,7 +2,7 @@
 #' 
 #' @description Many functions expect Dates. 
 #' Determining that they are validly entered is often quite 
-#' computatationally costly, relative to the core calculations.
+#' computationally costly, relative to the core calculations.
 #' These internal functions provide mechanisms to check validity
 #' quickly, while still providing clear, accurate error messages.
 #'