BuyseTest (version 3.0.5)

S4BuysePower-summary: Summary Method for Class "S4BuysePower"

Description

Summarize the results from the powerBuyseTest function.

Usage

# S4 method for S4BuysePower
summary(
  object,
  statistic = NULL,
  endpoint = NULL,
  order.Hprojection = NULL,
  transformation = NULL,
  print = TRUE,
  legend = TRUE,
  col.rep = FALSE,
  digit = 4,
  ...
)

Value

data.frame

Arguments

object

output of powerBuyseTest

statistic

[character] statistic relative to which the power should be computed: "netBenefit" displays the net benefit, as described in Buyse (2010) and Peron et al. (2016)), "winRatio" displays the win ratio, as described in Wang et al. (2016), "mannWhitney" displays the proportion in favor of the treatment (also called Mann-Whitney parameter), as described in Fay et al. (2018). Default value read from BuyseTest.options().

endpoint

[character vector] the endpoints to be displayed: must be the name of the endpoint followed by an underscore and then by the threshold.

order.Hprojection

[integer 1,2] the order of the H-project to be used to compute the variance of the net benefit/win ratio.

transformation

[logical] should the CI be computed on the logit scale / log scale for the net benefit / win ratio and backtransformed.

print

[logical] Should the table be displayed?.

legend

[logical] should explainations about the content of each column be displayed?

col.rep

[logical] should the number of successful simulations be displayed?

digit

[integer vector] the number of digit to use for printing the counts and the delta.

...

Not used. For compatibility with the generic method.

Author

Brice Ozenne

See Also

powerBuyseTest for performing a simulation study for generalized pairwise comparison.