power-class: Class "power" and its subclasses "powPar", "powFun",...

In sse: Sample Size Estimation

Description

A class used internally for storing information about the power calculation. It inherits from different classes, see section "Extends" for details.

Usage

## S4 method for signature 'power'
show(object)
## S4 method for signature 'powPar'
dim(x)
## S4 method for signature 'powCalc'
dim(x)

Arguments

object,x

object of class power, powPar or powCalc

Extends

The power-class has no privat slots but inherits everything from its ancestors.

Class powPar, by class powCalc, distance 2. Class powFun, by class powCalc, distance 2. Class powCalc, directly. Class powEx, directly.

powPar-class

A class used internally. Contains all the parameters needed to feed the 'power function'. For users there is a function powPar that constructs objects of this class and there are several functions for extracting information n, theta, xi, pp. These functions should be used when writing the 'power function'. Contains the Slots:

list:

Object of class "list" that contains all elements that were provided to powPar with the ... argument.

theta:

An "numeric" vector with values that are used to evaluate the power.

theta.name:

Object of class "character" only used if argument 'theta.name' of powPar was used.

theta.act:

Object of class "numeric". This slot is only used during evaluation where it contains one element of 'theta' after the other. The function theta extracts this value. If not under evaluation this slot contains the first element of 'theta'.

xi:

Object of class "numeric" with values that are used to evaluate the power.

xi.name:

Object of class "character" only used if argument 'theta.name' of powPar was used.

xi.act:

Object of class "numeric". This slot is only used during evaluation where it contains one element of 'xi' after the other. The function xi extracts this value. If not under evaluation this slot contains the first element of xi'.

n:

Object of class "integer" with values that are used to evaluate the power.

n.act:

Object of class "integer". This slot is only used during evaluation where it contains one element of 'n' after the other. The function n extracts this value. If not under evaluation this slot contains the first element of 'n'.

powFun-class

A class used internally. It contains the user defined 'power function' and some information about what this function returns.

showMethods(class = "powFun") shows what methods are available.

Contains the Slots:

statistic:

Object of class "function"

return.power:

Object of class "logical", indicating if the 'power function' returns a "logical".

return.list:

Object of class "logical", indicating if the 'power function' returns a "list".

return.n:

Object of class "integer", indicating the number of elements returned by the 'power function'.

return.names:

Object of class "character", indicating the name of the elements returned by the 'power function'.

powCalc-class

A class used internally. Objects can be created by calls to the function powCalc.

showMethods(class = "powCalc") shows what methods are available.

Contains the Slots:

core:

Object of class "array" with 4 dimentions, n, theta, xi and endpoint.

core:

Object of class "array" with 4 dimentions, n, theta, xi and endpoint.

statistic:

Object of class "function", this function was used for calculating the power.

endpoint.name:

Object of class "character" names of the endpoints

iter:

Object of class "integer" how many iterations were used to estimate the power

powEx-class

A class used internally. Objects can be created by calls to the function powEx but are never visible because they are directly included in power.

showMethods(class = "powEx") shows what methods are available.

Contains the Slots:

theta.example:

Object of class "numeric", the value of the parameter 'theta' used for illustration and for estimating sample size.

xi.example:

Object of class "numeric" Like 'theta.example' but for 'xi'.

endpoint.example:

Object of class "character", the endpoint to be used, only if several endpoints were evaluated.

power.example:

Object of class "numeric", indicating for which power the sample size should be evaluated and which power (contourline) should be used for illustration plot.

method:

Object of class "character", indicating which 'method' was used for sample size estimation, see powEx.

lm.range:

Object of class "numeric", indicating which 'lm.range' was used for sample size estimation, see powEx.

drop:

Object of class "numeric", indicating which drop out rate was used for sample size estimation, see powEx.

forceDivisor:

Object of class "logical", indicating whether a divisability was forced for sample size estimation, see powEx.

divisor:

Object of class "logical", indicating which 'divisor' was enforced for sample size estimation, see powEx.

power-class

A class used internally. Objects can be created by calls to the function powEx.

showMethods(class = "power") shows what methods are available.

For the users important are inspect, plot, tex.

Author(s)

[e-mail]

Examples

showClass("power")

sse documentation built on May 19, 2021, 3 p.m.