S4BuyseTest-coef {BuyseTest}R Documentation

Coef Method for Class "S4BuyseTest"

Description

Extract summary statistics from the result of a BuyseTest function.

Usage

## S4 method for signature 'S4BuyseTest'
coef(
  object,
  endpoint = NULL,
  statistic = NULL,
  stratified = FALSE,
  cumulative = NULL,
  resampling = FALSE,
  ...
)

Arguments

object

output of BuyseTest

endpoint

[character] for which endpoint(s) the summary statistic should be output? If NULL returns the summary statistic for all endpoints.

statistic

[character] the type of summary statistic. See the detail section.

stratified

[logical] should the summary statistic be strata-specific? Otherwise a summary statistic over all strata is returned.

cumulative

[logical] should the summary statistic be cumulated over endpoints? Otherwise display the contribution of each endpoint.

resampling

[logical] should the summary statistic obtained by resampling be output?

...

ignored.

Details

One of the following statistic can be specified:

Value

When resampling=FALSE and stratified=FALSE, return a numeric vector. When resampling=FALSE and stratified=TRUE, return a matrix. When resampling=TRUE and stratified=FALSE, return a matrix. When resampling=TRUE and stratified=TRUE, return an 3-dimensional array.

Author(s)

Brice Ozenne


[Package BuyseTest version 2.4.0 Index]