Parameter Names — pars.term • term

Gets the parameter names.

Usage

# S3 method for class 'term'
pars(x, scalar = NULL, terms = FALSE, ...)

Arguments

x: An object.
scalar: A flag specifying whether to by default return all parameters (NULL), or only scalar parameters (TRUE) or only non-scalar parameters (FALSE).
terms: A flag specifying whether to return the parameter name for each term element. Use pars_terms() instead.
...: Other arguments passed to methods.

Value

A character vector of the names of the parameters.

Details

The terms argument is . Use pars_terms() to get the parameter name for each term element.

See also

universals::pars

Other parameters: pars.character(), pars.default(), pars.term_rcrd(), pars_terms()

Examples

term <- term(
  "alpha[1]", "alpha[2]", "beta[1,1]", "beta[2,1]",
  "beta[1,2]", "beta[2,2]", "sigma", NA
)
pars(term)
#> [1] "alpha" "beta"  "sigma" NA     
pars(term, scalar = TRUE)
#> [1] "sigma" NA     
pars(term, scalar = FALSE)
#> [1] "alpha" "beta"  NA