BuyseRes-summary {BuyseTest} | R Documentation

## Summary Method for Class "BuyseRes"

### Description

Summarize the results from the `BuyseTest` function.

### Usage

    ## S4 method for signature 'BuyseRes'
    summary(object, print = TRUE, percentage = TRUE,
      statistic = NULL, conf.level = NULL, strata = if
      (length(object@level.strata) == 1) {     "global" } else {     NULL },
      digit = c(2, 4), ...)

### Arguments

`object` | output of `BuyseTest`
`print` | [logical] Should the table be displayed?.
`percentage` | [logical] Should the percentage of pairs of each type be displayed ? Otherwise the number of pairs is displayed.
`statistic` | [character] the statistic summarizing the pairwise comparison: `"netBenefit"` displays the net benefit, as described in Buyse (2010) and Peron et al. (2016)), whereas `"winRatio"` displays the win ratio, as described in Wang et al. (2016). Default value read from `BuyseTest.options()`.
`conf.level` | [numeric] confidence level for the confidence intervals. Default value read from `BuyseTest.options()`.
`strata` | [character vector] the name of the strata to be displayed. Can also be `"global"` to display the average over all strata.
`digit` | [integer vector] the number of digit to use for printing the counts and the delta.
`...` | arguments to be passed to `confint`

### Details

When using a permutation test, the uncertainty associated with the estimator is computed under the null hypothesis. Thus the confidence interval may not be valid if the null hypothesis is false.
More precisely, the quantiles of the distribution of the statistic are computed under the null hypothesis and then shifted by the point estimate of the statistic. Therefore it is possible that the limits of the confidence interval are estimated outside of the interval of definition of the statistic (e.g. outside [-1,1] for the proportion in favor of treatment).

Note: For the win ratio, the proposed implementation enables the use of thresholds and endpoints that are not time to events as well as the correction proposed in Peron et al. (2016) to account for censoring. These development have not been examined by Wang et al. (2016), or in other papers (at out knowledge). They are only provided here by implementation convenience.

### See Also

`BuyseTest` for performing a generalized pairwise comparison.
`BuyseRes-class` for a presentation of the `BuyseRes` object.

### Examples

    dt <- simBuyseTest(1e2, n.strata = 3)

     ## Not run:
     BT <- BuyseTest(Treatment ~ TTE(eventtime, censoring = status) + Bin(toxicity), data=dt)

    ## End(Not run)

     summary(BT)
     summary(BT, percentage = FALSE)
     summary(BT, statistic = "winRatio")

[Package BuyseTest version 1.7 Index]