print.regmedint: print method for regmedint object

View source: R/08_regmedint_class_user_methods.R

print.regmedintR Documentation

print method for regmedint object

Description

Print the mreg_fit, yreg_fit, and the mediation analysis effect estimates.

Usage

## S3 method for class 'regmedint'
print(
  x,
  a0 = NULL,
  a1 = NULL,
  m_cde = NULL,
  c_cond = NULL,
  args_mreg_fit = list(),
  args_yreg_fit = list(),
  ...
)

Arguments

x

An object of the regmedint class.

a0

A numeric vector of length 1

a1

A numeric vector of length 1

m_cde

A numeric vector of length 1 The mediator value at which the controlled direct effect (CDE) conditional on the adjustment covariates is evaluated. If not provided, the default value supplied to the call to regmedint will be used. Only the CDE is affected.

c_cond

A numeric vector of the same length as cvar. A set of covariate values at which the conditional natural effects are evaluated.

args_mreg_fit

A named list of argument to be passed to the method for the mreg_fit object.

args_yreg_fit

A named list of argument to be passed to the method for the mreg_fit object.

...

For compatibility with the generic. Ignored.

Value

Invisibly return the regmedint class object as is.

Examples

library(regmedint)
data(vv2015)
regmedint_obj <- regmedint(data = vv2015,
                           ## Variables
                           yvar = "y",
                           avar = "x",
                           mvar = "m",
                           cvar = c("c"),
                           eventvar = "event",
                           ## Values at which effects are evaluated
                           a0 = 0,
                           a1 = 1,
                           m_cde = 1,
                           c_cond = 0.5,
                           ## Model types
                           mreg = "logistic",
                           yreg = "survAFT_weibull",
                           ## Additional specification
                           interaction = TRUE,
                           casecontrol = FALSE)
## Implicit printing
regmedint_obj
## Explicit printing
print(regmedint_obj)
## Evaluate at different values
print(regmedint_obj, m_cde = 0, c_cond = 1)


regmedint documentation built on April 7, 2022, 1:17 a.m.