R/demographic.R

In balima78/simK: Synthetic Data on Kidney Transplantation

#' Builds a vector with truncated ages
#'
#' @description Returns a vector with ages with a normal distribution truncated
#' by upper and upper limits.
#' @param n An integer to define the length of the returned vector.
#' @param lower An integer for ages' lower limit.
#' @param upper An integer for ages' upper limit.
#' @param mean A value for mean's distribution.
#' @param sd A value for standar deviation's distribution.
#' @return A vector length `n` with normal distributed truncated ages.
#' @examples
#' ages(n = 100, lower=18, upper=75, mean = 55, sd = 15)
#' @export
#' @concept demographic_parameters
ages <- function(n = 100, lower=18, upper=75, mean = 55, sd = 15){

  if(!is.numeric(n) | n < 1){stop("`n` must be a positive single number!\n")}
  if(!is.numeric(mean) | n < 1){stop("`mean` must be a positive single number!\n")}
  if(!is.numeric(sd) | n < 1){stop("`sd` must be a positive single number!\n")}
  if(!is.numeric(lower) | n < 1){stop("`lower` must be a positive single number!\n")}
  if(!is.numeric(upper) | n < 1){stop("`upper` must be a positive single number!\n")}

  round(
    truncnorm::rtruncnorm(n = n, a=lower, b=upper, mean = mean, sd = sd)
  )

}