S4BuyseTest-coef {BuyseTest} | R Documentation |
Extract Summary Statistics from GPC
Description
Extract summary statistics (net benefit, win ratio, ...) from GPC.
Usage
## S4 method for signature 'S4BuyseTest'
coef(
object,
endpoint = NULL,
statistic = NULL,
strata = FALSE,
cumulative = NULL,
resampling = FALSE,
simplify = TRUE,
...
)
Arguments
object |
a |
endpoint |
[character] for which endpoint(s) the summary statistic should be output?
If |
statistic |
[character] the type of summary statistic. See the detail section. |
strata |
[character vector] the strata relative to which the statistic should be output.
Can also be |
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? |
simplify |
[logical] should the result be coerced to the lowest possible dimension? |
... |
ignored. |
Details
One of the following statistic can be specified:
-
"netBenefit"
: returns the net benefit. -
"winRatio"
: returns the win ratio. -
"favorable"
: returns the proportion in favor of the treatment (also called Mann-Whitney parameter). -
"unfavorable"
: returns the proportion in favor of the control. -
"unfavorable"
: returns the proportion of neutral pairs. -
"unfavorable"
: returns the proportion of uninformative pairs. -
"count.favorable"
: returns the number of pairs in favor of the treatment. -
"count.unfavorable"
: returns the number of pairs in favor of the control. -
"count.neutral"
: returns the number of neutral pairs. -
"count.uninf"
: returns the number of uninformative pairs.
Value
When resampling=FALSE
and simplify=FALSE
, a matrix (strata, endpoint).
When resampling=FALSE
and simplify=FALSE
, an array (sample, strata, endpoint).
Author(s)
Brice Ozenne