R/summary.R

In santikka/dynamite: Bayesian Modeling and Causal Inference for Multivariate Longitudinal Data

#' Summary for a \pkg{dynamite} Model Fit
#'
#' The `summary()` method provides statistics of the posterior samples of the
#' model; this is an alias of [as.data.frame.dynamitefit()] with
#' `summary = TRUE`.
#'
#' @export
#' @family output
#' @rdname dynamite
#' @param object \[`dynamitefit`]\cr The model fit object.
#' @return `summary` returns a `data.frame`.
#' @srrstats {BS6.4, RE4.18} Implements `summary` method.
#' @examples
#' data.table::setDTthreads(1) # For CRAN
#' summary(gaussian_example_fit,
#'   types = "beta",
#'   probs = c(0.05, 0.1, 0.9, 0.95)
#' )
#'
summary.dynamitefit <- function(object, ...) {
  stopifnot_(
    !missing(object),
    "Argument {.arg object} is missing."
  )
  stopifnot_(
    is.dynamitefit(object),
    "Argument {.arg object} must be a {.cls dynamitefit} object."
  )
  as.data.frame.dynamitefit(object, summary = TRUE, ...)
}