R/params.R

#' Parameter Descriptions for term Functions
#'
#' @param x The object.
#' @param name A string specifying the name of the parameter.
#' @param ... Unused.
#'
#' @param validate A string specifying the level of the validation.
#' The possible values in order of increasing strictness
#' are 'class', 'valid', 'consistent' and 'complete'.
#' @param repair A flag specifying whether to repair terms.
#' @param normalize A flag specifying whether to normalize terms.
#' @param select A character vector of the names of the parameters to include in the subsetted object.
#'
#' @param value A character vector of the new parameter names.
#' @param pars A character vector of parameter names.
#' @param scalar A flag specifying whether to by default return all parameters (NULL), or only scalar parameters (TRUE) or only non-scalar parameters (FALSE).
#' @param terms A flag specifying whether to return the parameter name
#' for each term element.
#' @param incomparables Ignored.
#'
#' @name params
#' @keywords internal
NULL

Try the term package in your browser

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

term documentation built on Sept. 29, 2022, 5:14 p.m.