R/coef.R

In brokenstick: Broken Stick Model for Irregular Longitudinal Data

#' Extract Model Coefficients from brokenstick Object
#'
#' @rdname coef
#' @param object A \code{brokenstick} object
#' @param hide Should output for boundary knots be hidden in the print,
#' summary and plot functions? Can be `"right"`, `"left"`, `"boundary"`,
#' `"internal"` or `"none"`.
#' If not specified, it is read from `object$hide`.
#' @inheritParams stats::coef
#' @export
coef.brokenstick <- function(
  object,
  complete = TRUE,
  ...,
  hide = c("right", "left", "boundary", "internal", "none")
) {
  if (!missing(hide)) {
    hide <- match.arg(hide)
  } else {
    hide <- ifelse(is.null(object$hide), "right", object$hide)
  }

  beta <- object$beta
  beta <- switch(
    hide,
    right = beta[-length(beta)],
    left = beta[-1L],
    boundary = beta[-c(1L, length(beta))],
    internal = beta[c(1L, length(beta))],
    none = beta
  )

  if (complete) {
    return(beta)
  } else {
    beta[!is.na(beta)]
  }
}