R/pars-terms.R

In poissonconsulting/term: Create, Manipulate and Query Parameter Terms

#' Term Parameters
#'
#' Gets the name of each parameter for each term.
#'
#' The scalar argument is `r lifecycle::badge("defunct")`.
#'
#' @inheritParams params
#' @param x A term vector.
#' @return A character vector of the term parameter names.
#' @family parameters
#' @export
#'
#' @examples
#' term <- term(
#'   "alpha[1]", "alpha[2]", "beta[1,1]", "beta[2,1]",
#'   "beta[1,2]", "beta[2,2]", "sigma", NA
#' )
#' pars_terms(term)
pars_terms <- function(x, scalar = NULL, ...) {
  if (!vld_s3_class(x, "term") && !vld_s3_class(x, "term_rcrd")) {
    chkor_vld(vld_s3_class(x, "term"), vld_s3_class(x, "term_rcrd"))
  }
  if (!missing(scalar)) {
    deprecate_soft("0.2.1", "term::pars_terms(scalar =)")
  }
  chk_unused(...)
  x <- as_term_rcrd(x)

  if (!is.null(scalar)) {
    x <- x[scalar_term(x) == scalar]
  }
  field(x, "par")
}