R/add1_stdmod.R

Defines functions add1.std_selected

Documented in add1.std_selected

#' @title The 'add1' Method for a 'std_selected' Class Object
#'
#' @description Intercept the [add1()] method and raise an error.
#'
#' @details [add1()] should not be used after the output of [lm()] is
#'  processed by [std_selected()] or [std_selected_boot()].
#'
#' @param object The output of [std_selected()] or [std_selected_boot()].
#' @param ...  Additional arguments. They will be ignored.
#'
#' @return It returns nothing. It is called for its side effect.
#'
#' @author Shu Fai Cheung <https://orcid.org/0000-0002-9871-9448>
#'
#' @export

add1.std_selected <- function(object, ...) {
    stop(paste0("add1 should be used on the lm() call first and then ",
                "call std_selected() or std_selected_boot() again."))
  }

Try the stdmod package in your browser

Any scripts or data that you put into this service are public.

stdmod documentation built on Sept. 30, 2024, 9:42 a.m.