R/computeSF2.R

In RadioGx: Analysis of Large-Scale Radio-Genomic Data

#' Compute SF2
#'
#' This function computes the survival fraction after administering
#'   2 units of radiation, given alpha and beta in the equation
#'   SF = exp(-alpha * D - beta * D ^ 2).
#'
#' @examples computeSF2(c(0.2, 0.1))
#'
#' @param pars parameters (alpha, beta) in equation
#'   y = exp(-alpha * x - beta * x ^ 2)
#'
#' @return \code{numeric} The survival fraction
#'
#' @export
computeSF2 <- function(pars) {

  CoreGx::.sanitizeInput(pars = pars,
                          x_as_log = FALSE,
                          y_as_log = FALSE,
                          y_as_pct = FALSE,
                          trunc = FALSE,
                          verbose = FALSE)

  SF <- .linearQuadratic(D = 2,
                         pars = pars,
                         SF_as_log = FALSE)

  return(SF)
}