R/prep_cost-eff_constructors.R

In n8thangreen/ltbiScreenLite: ltbiScreenLite

#' TB test constructor
#'
#' Define properties and assign \code{test} class.
#'
#' @param sens test sensitivity
#' @param spec test specificity
#'
#' @return list
#' @export
#'
#' @examples
#'
test <- function(sens,
                 spec) {

  stopifnot(inherits(sens, "branch_unif_params"))
  stopifnot(inherits(spec, "branch_unif_params"))

  res <-
    list(sens = sens,
         spec = spec)

  class(res) <- c("test", class(res))

  return(res)
}

#' branch_unif_params constructor
#'
#' Define properties and assign \code{branch_unif_params} class.
#'
#' @param pmin Minimum probability
#' @param pmax Maximum probability
#' @param name Node label
#'
#' @return list
#' @export
#'
#' @examples
#'
branch_unif_params <- function(pmin,
                               pmax,
                               name) {

  stopifnot(pmin >= 0, pmax <= 1)

  res <-
    list(pmin = pmin,
         pmax = pmax,
         name = name)

  class(res) <- c("branch_unif_params", class(res))

  return(res)
}