R/calculatepower.R

In tylermorganwall/skpr: Design of Experiments Suite: Generate and Evaluate Optimal Designs

#'@title Calculate Power
#'
#'@description Calculates the power of the model given the non-centrality parameter
#'
#'@param X The model matrix
#'@param L The parameter matrix/vector
#'@param lambda The non-centrality parameter for the F test
#'@param alpha the specified type-I error
#'@param degrees_of_freedom The number of degrees of freedom.
#'@return The power for a given parameter L, given the
#'@keywords internal
calculatepower = function(X, L, lambda, alpha, degrees_of_freedom) {
  return(
    1 -
      pf(
        qf(1 - alpha, dim(L)[1], degrees_of_freedom),
        dim(L)[1],
        degrees_of_freedom,
        lambda
      )
  )
}