S4BuysePower-model.tables: Extract Summary for Class "S4BuysePower"

S4BuysePower-model.tablesR Documentation

Extract Summary for Class "S4BuysePower"

Description

Extract a summary of the results from the powerBuyseTest function.

Usage

## S4 method for signature 'S4BuysePower'
model.tables(
  x,
  type = "summary",
  statistic = NULL,
  endpoint = NULL,
  order.Hprojection = NULL,
  transformation = NULL
)

Arguments

x

output of powerBuyseTest

type

[character] should a summary of the results ("summary") or the raw results ("raw") be output?

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.

Value

data.frame

Author(s)

Brice Ozenne

See Also

powerBuyseTest for performing a simulation study for generalized pairwise comparison.


bozenne/BuyseTest documentation built on Feb. 16, 2024, 5:35 a.m.