R/add.R

Defines functions add

Documented in add

### add.R --- 
##----------------------------------------------------------------------
## Author: Brice Ozenne
## Created: sep 23 2022 (16:58) 
## Version: 
## Last-Updated: jun 14 2023 (14:40) 
##           By: Brice Ozenne
##     Update #: 5
##----------------------------------------------------------------------
## 
### Commentary: 
## 
### Change Log:
##----------------------------------------------------------------------
## 
### Code:

##' @title Add Columns to Output
##' @description Auxiliary function that can be used when specifying the argument \code{columns} (e.g. calling \code{confint.lmm}) to add columns.
##'
##' @param ... [character vector] name of the columns to be added to the default output.
##'
##' @return A character vector
##'
##' @keywords utilities
##' 
##' @examples
##' set.seed(10)
##' dW <- sampleRem(25, n.times = 1, format = "long")
##' e.lmm <- lmm(Y~X1, data = dW)
##'
##' confint(e.lmm, columns = add("statistic"))

##' @export
add <- function(...){
    dots <- list(...)
    return(stats::setNames(unlist(dots),rep("add",length(dots))))
}
    

##----------------------------------------------------------------------
### add.R ends here

Try the LMMstar package in your browser

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

LMMstar documentation built on Nov. 9, 2023, 1:06 a.m.