print.powerSim {simr}

Report simulation results

Description

Describe and extract power simulation results

Usage

## S3 method for class 'powerSim'
print(x, alpha = x$alpha, level = 0.95, ...)

## S3 method for class 'powerCurve'
print(x, ...)

## S3 method for class 'powerSim'
summary(
  object,
  alpha = object$alpha,
  level = 0.95,
  method = getSimrOption("binom"),
  ...
)

## S3 method for class 'powerCurve'
summary(
  object,
  alpha = object$alpha,
  level = 0.95,
  method = getSimrOption("binom"),
  ...
)

## S3 method for class 'powerSim'
confint(
  object,
  parm,
  level = 0.95,
  method = getSimrOption("binom"),
  alpha = object$alpha,
  ...
)

## S3 method for class 'powerCurve'
confint(object, parm, level = 0.95, method = getSimrOption("binom"), ...)

Arguments

x

a powerSim or powerCurve object

alpha

the significance level for the statistical test (default is that used in the call to powerSim).

level

confidence level for power estimate

...

additional arguments to pass to binom::binom.confint()

alpha refers to the threshold for an effect being significant and thus directly determines the point estimate for the power calculation. level is the confidence level that is calculated for this point evidence and determines the width/coverage of the confidence interval for power.

object

a powerSim or powerCurve object

method

method to use for computing binomial confidence intervals (see binom::binom.confint())

parm

currently ignored, included for S3 compatibility with stats::confint

See Also

binom::binom.confint, powerSim, powerCurve