R/classes.R

In MatheMax/OptReSample: Computing Optimal Adaptive Designs

#' Creating design objects
#'
#' \code{design} creats an object of class \code{design}.
#'
#' @param cf Boundary for stopping for futility
#' @param ce Boundary for stopping for efficacy
#' @param n1 First stage sample size
#' @param n2 Function of z which gives the stage two sample size
#' @param c2 Function of z which gives the stage two rejection boundary
#'
#' @return An object of class \code{design}
#' @export

design <- function(
  cf,
  ce,
  n1,
  n2,
  c2
) {
  if (!is.numeric(n1)) {
    stop("n1 must be integer")
  }
  return(
    structure(list(
      n1 = n1,
      cf = cf,
      ce = ce,
      n2  = n2,
      c2  = c2
    ), class = c("Design"))
  )
}


#' Creating parameters object
#'
#' \code{parameters} creats an object of class \code{parameters} which is needed for many functions in this package.
#'
#' @param mu Standardized effect value of the alternative hypothesis
#' @param alpha Maximal type I error rate
#' @param beta Maximal type II error rate
#'
#' @return An object of class \code{parameters.}
#' @export

parameters <- function(
  mu,
  alpha,
  beta
) {
    return(
    structure(list(
      mu = mu,
      alpha = alpha,
      beta = beta
    ), class = c("Parameters"))
  )
}