mmrm_methods: Methods for 'mmrm' Objects

mmrm_methodsR Documentation

Methods for mmrm Objects

Description

[Stable]

Usage

## S3 method for class 'mmrm'
summary(object, ...)

## S3 method for class 'summary.mmrm'
print(
  x,
  digits = max(3, getOption("digits") - 3),
  signif.stars = getOption("show.signif.stars"),
  ...
)

## S3 method for class 'mmrm'
confint(object, parm, level = 0.95, ...)

Arguments

object

(mmrm)
the fitted MMRM including Jacobian and call etc.

...

not used.

Details

While printing the summary of (mmrm)
object, the following will be displayed:

  1. Formula. The formula used in the model.

  2. Data. The data used for analysis, including number of subjects, number of valid observations.

  3. Covariance. The covariance structure and number of variance parameters.

  4. Method. Restricted maximum likelihood(REML) or maximum likelihood(ML).

  5. Model selection criteria. AIC, BIC, log likelihood and deviance.

  6. Coefficients. Coefficients of the covariates.

  7. Covariance estimate. The covariance estimate(for each group).

    1. If the covariance structure is non-spatial, the covariance matrix of all categorical time points available in data will be displayed.

    2. If the covariance structure is spatial, the covariance matrix of two time points with unit distance will be displayed.

confint is used to obtain the confidence intervals for the coefficients. Please note that this is different from the confidence interval of difference of least square means from emmeans.

Value

Depends on the method, see Details and Functions.

Functions

  • summary(mmrm): summarizes the MMRM fit results.

  • print(summary.mmrm): prints the MMRM fit summary.

  • confint(mmrm): obtain the confidence intervals for the coefficients.

See Also

mmrm_tmb_methods, mmrm_tidiers for additional methods.

Examples

formula <- FEV1 ~ RACE + SEX + ARMCD * AVISIT + us(AVISIT | USUBJID)
object <- mmrm(formula, fev_data)
# Summary:
summary(object)
# Confidence Interval:
confint(object)

mmrm documentation built on Oct. 7, 2024, 1:14 a.m.