steppes-class: Class '"steppes"'

In stepp: Subpopulation Treatment Effect Pattern Plot (STEPP)

Class "steppes"

Description

This is the stepp object for stepp results. It keeps track of all the estimates, covariance matrices and the test statistics

Value

The new method returns the steppes object.

Objects from the Class

Objects can be created by calls of the form new("steppes", ...) or by the constructor function stepp.test.

Slots

subpop:

Object of class "stsubpop"
the filled stepp subpopulation object

model:

Object of class "stmodel"
the model of the data to be used for stepp analysis

effect:

Object of class "ANY"
effect estimates of each subpopulation in absolute and relative scales
list return from the estimate methods of various stepp models
see documentation in various stepp models for details on what is in the list

testresults:

Object of class "ANY"
permutation or GEE test results and various covariance matrices
list return from the test methods of various stepp models
see documentation in various stepp models for details on what is in the list

nperm:

Object of class "numeric"
number of permutation for the permutation test; default is 2500

Methods

estimate

signature(.Object = "steppes", sp, model):
estimate the effect in absolute and relative scale of the overall and each subpopulation for the specified subpopulation using the specified model.

plot

signature(.Object = "steppes"):
generate the three stepp plots

print

signature(.Object = "steppes", estimate=TRUE, cov=TRUE, test=TRUE):
print the estimates, covariance matrices and statistics from the stepp analysis

summary

signature(.Object = "steppes"):
produce a summary of the steppes object

test

signature(.Object = "steppes", nperm=100, showstatus=TRUE):
perform the permutation tests and obtain various statistics. Number of permutation is default to 100 and status bar to show.

Note

The plot function for steppes class generates 3 plots at once. If you are using R studio for development, you can only get the last plot as R studio only allows one graphical device. There is a simple workaround. By writing the plots to pdf files in your working directory, you can display them outside of R studio.

Author(s)

Wai-Ki Yip

See Also

stwin, stsubpop, stmodelKM, stmodelCI, stmodelGLM,stmodel, stepp.win, stepp.subpop, stepp.KM, stepp.CI, stepp.GLM, stepp.test, estimate, generate

Examples

showClass("steppes")

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