R/income.R

In wakefield: Generate Random Data Sets

#' Generate Random Gamma Vector of Incomes
#'
#' Generate a random gamma vector of incomes.
#'
#' @details Incomes are generated using: \code{rgamma(n, 2) * 2000}.
#' @param n The number elements to generate.  This can be globally set within
#' the environment of \code{r_data_frame} or \code{r_list}.
#' @param digits Integer indicating the number of decimal places to be used.
#' Negative values are allowed (see \code{\link[base]{round}}).
#' @param name The name to assign to the output vector's \code{varname}
#' attribute.  This is used to auto assign names to the column/vector name when
#' used inside of \code{r_data_frame} or \code{r_list}.
#' @return Returns a random gamma vector of income elements.
#' @keywords income
#' @export
#' @family variable functions
#' @seealso \code{\link[base]{gamma}}
#' @examples
#' income(10)
#' hist(income(10000))
#' pie(table(cut(income(10000), 10)))
income <-
function (n, digits = 2, name = "Income") {

    if (missing(n)) stop("`n` is missing")
    out <- round(stats::rgamma(n, 2) * 20000, digits = digits)
    varname(out, name)

}