rbmiUtils (version 0.3.0)

summary.analysis: Summary Method for Analysis Objects

Description

Provides a detailed summary of an analysis object from analyse_mi_data().

Usage

# S3 method for analysis
summary(object, n_preview = 5, ...)

Value

A list containing summary information (invisibly).

Arguments

object

An object of class analysis.

n_preview

Maximum number of parameters to show in the preview table. Defaults to 5.

...

Additional arguments (currently unused).

Examples

# \donttest{
library(rbmi)
library(rbmiUtils)
data("ADMI")

# Create analysis object
vars <- set_vars(
  subjid = "USUBJID", visit = "AVISIT", group = "TRT",
  outcome = "CHG", covariates = c("BASE", "STRATA")
)
method <- method_bayes(n_samples = 10, control = control_bayes(warmup = 10))

ana_obj <- analyse_mi_data(ADMI, vars, method, fun = function(d, v, ...) 1)
summary(ana_obj)
# }