From 32c44a69856699b63bee702796cd0c8ae221c374 Mon Sep 17 00:00:00 2001 From: "Adam B. Smith" Date: Tue, 2 Jan 2024 14:44:51 -0600 Subject: [PATCH] Update help --- R/makeFormulae.r | 2 +- man/makeFormulae.Rd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/R/makeFormulae.r b/R/makeFormulae.r index cb32dad..a40cfdb 100644 --- a/R/makeFormulae.r +++ b/R/makeFormulae.r @@ -8,7 +8,7 @@ #' @param linearOnly Logical: If \code{TRUE} (default) then models with only linear terms are included in final set (plus other kinds of models if desired). #' @param quad Logical: If \code{TRUE} (default), then include quadratic terms. #' @param ia Logical: If \code{TRUE} (default), then include 2-way interaction terms. -#' @param verboten Character vector of terms that should not appear in the models. Ignored if \code{NULL} (default). You can use this argument, for example, to exclude specific interactions (e.g., \code{'x1:x2'}, but also include the converse, \code{'x2:x1'}), or power terms (e.g., \code{'I\\(x1\\^2\\)'}). Note that to ensure matching, you need to use double backslash in front of parentheses and the caret (\code(^)) characters. +#' @param verboten Character vector of terms that should not appear in the models. Ignored if \code{NULL} (default). You can use this argument, for example, to exclude specific interactions (e.g., \code{'x1:x2'}, but also include the converse, \code{'x2:x1'}), or power terms (e.g., \code{'I(x1^2)'}). Note that to ensure proper matching, you need to use a double backslash in front of each parenthesis and caret (\code(^)) character. #' @param verbotenCombos List of lists: Used to specify specific combinations of terms that should not occur together. See \emph{Details} below. Ignored if \code{NULL} (default). #' @param minTerms Either a positive integer representing the minimum number of terms required to be in a model, \emph{or} \code{NULL} (default) in which case the smallest model can have just one term. #' @param maxTerms Either a positive integer representing the maximum number of terms allowed to be in a model, \emph{or} \code{NULL} (default) in which case there is no practical limit on the number of terms in a model. diff --git a/man/makeFormulae.Rd b/man/makeFormulae.Rd index 61a54fb..a068e02 100644 --- a/man/makeFormulae.Rd +++ b/man/makeFormulae.Rd @@ -32,7 +32,7 @@ makeFormulae( \item{ia}{Logical: If \code{TRUE} (default), then include 2-way interaction terms.} -\item{verboten}{Character vector of terms that should not appear in the models. Ignored if \code{NULL} (default). You can use this argument, for example, to exclude specific interactions (e.g., \code{'x1:x2'}, but also include the converse, \code{'x2:x1'}), or power terms (e.g., \code{'I\\(x1\\^2\\)'}). Note that to ensure matching, you need to use double backslash in front of parentheses and the caret (\code(^)) characters.} +\item{verboten}{Character vector of terms that should not appear in the models. Ignored if \code{NULL} (default). You can use this argument, for example, to exclude specific interactions (e.g., \code{'x1:x2'}, but also include the converse, \code{'x2:x1'}), or power terms (e.g., \code{'I(x1^2)'}). Note that to ensure proper matching, you need to use a double backslash in front of each parenthesis and caret (\code(^)) character.} \item{verbotenCombos}{List of lists: Used to specify specific combinations of terms that should not occur together. See \emph{Details} below. Ignored if \code{NULL} (default).}