stepp_print: The function to print the estimate, covariance matrices and...

View source: R/stepp.R

stepp_printR Documentation

The function to print the estimate, covariance matrices and test statistics.

Description

This function will be deprecated in the future. Please use S4 classes and generic functions summary, print and plot for future development.

A method to print three essential information resulting from the STEPP analysis.

Usage

  stepp_print(x, estimate=TRUE, cov=TRUE, test=TRUE)

Arguments

x

a steppes object returned from stepp, analyze.KM.stepp or analyze.CumInc.stepp function

estimate

whether to print the effect estimates; default to yes

cov

whether to print the covariance matrices; default to yes

test

whether to print the test statistics; default to yes

Details

The STEPP analysis produces three important pieces of information. User can decide to print them all or individually. The three pieces of information are:

1. effect estimates of each subpopulation for the two treatments, the differences in absolute scale of the effects and the ratio in relative scale of the effects.
2. covariance matrics of the differences, logratios, differences in homogeneous association and logratios in homogeneous association.
3. various permutation p values based on test statistics: supremum pvalues, homogeneous association pvalues, chisquare pvalue. Not all statistics are available for all models.

Warning

This function together with other old functions will be depreciated in the future. A new set of S4 classes are implemented to replace old interfaces. Please use them for future development.

Author(s)

Wai-ki Yip, David Zahrieh, Marco Bonetti, Bernard Cole, Ann Lazar, Richard Gelber

See Also

The S4 classes: stwin, stsubpop, stmodelKM, stmodelCI, stmodelCOX, stmodelGLM, and steppes.

Old functions to be deprecated: stepp, stepp_summary, stepp_plot, analyze.CumInc.stepp and analyze.KM.stepp.

Examples

# see example in the documentation for the function stepp.

stepp documentation built on June 22, 2024, 9:24 a.m.

Related to stepp_print in stepp...