summary.effectsMed {sensmediation}R Documentation

Summary function for objects of class "effectsMed"

Description

Summary function for objects of class "effectsMed"

Usage

## S3 method for class 'effectsMed'
summary(object, non.sign = FALSE, ...)

## S3 method for class 'summaryeffectsMed'
print(x, digits = max(3, getOption("digits")
  - 3), ...)

Arguments

object

object of class "effectsMed"

non.sign

logical indicating whether sensitivity analysis results should be printed for non-significant effects.

...

additional arguments

x

object of class "summaryeffectsMed"

digits

number of digits to be printed.

Value

A list with values:

call

The matched call

Rho

The sensitivity parameter vector.

type

character, the type of confounding the sensitivity analysis is performed for.

conf.level

numeric, the confidence level used for confidence intervals and uncertainty intervals.

UI

matrix with the uncertainty intervals for the NIE (NIE*) and NDE (NDE*) over the range of the sensitivity parameter Rho.

covariates

list of the covariate values that the effects are conditioned on.

exp.name

character vector containing the name of the exposure.

med.name

character vector containing the name of the mediator.

alt.decomposition

logical, indicating whether the alternative definitions of the direct and indirect effects have been used

non.sign

logical indicating whether sensitivity analysis results are printed for non-significant effects.

effects

Results of the mediation analysis. Estimated NIE and NDE with confidence intervals and p-values for Rho = 0

ns.nie

values of Rho with estimated NIEs and confidence intervals where the NIE is not significant.

ns.nde

values of Rho with estimated NDEs and confidence intervals where the NDE is not significant.

rev.nie

values of Rho with estimated NIEs and confidence intervals where the NIE is reversed.

rev.nde

values of Rho with estimated NDEs and confidence intervals where the NDE is reversed.


[Package sensmediation version 0.3.0 Index]