R/set_options.R

In RobinL/costmodelr: Build cost models in R from lists of assumptions, with rigorous unit tests

#' Overwrite the default categorisation columns.  These enable the user to break down the results of the cost model into different categories
#' such as 'staff costs' and 'hardware costs' at different levels of granularity.
#'
#' Note that the defaults are 'id', 'category_1', 'cateogory_2', 'category_3'
#' @export
setting_categorisation_columns <- function (cost_model, categorisation_columns) {

  cost_model$categorisation_columns <- categorisation_columns
  cost_model

}

#' Add to the current categorisation columns.  These enable the user to break down the results of the cost model into different categories
#' such as 'staff costs' and 'hardware costs' at different levels of granularity.
#'
#' @export
setting_append_to_categorisation_columns <- function (cost_model, categorisation_columns) {

  cost_model$categorisation_columns <- c(cost_model$categorisation_columns, categorisation_columns)
  cost_model

}

#' Set the base date for the deflator (the date for which the gdp deflator = 100)
#'
#' @export
setting_deflator_base_date <- function(cost_model, base_date) {
  cost_model$base_date <- base_date
  cost_model
}