S4BuyseTest-coef | R Documentation |
Extract summary statistics from the result of a BuyseTest
function.
## S4 method for signature 'S4BuyseTest'
coef(
object,
endpoint = NULL,
statistic = NULL,
stratified = FALSE,
cumulative = NULL,
resampling = FALSE,
...
)
object |
output of |
endpoint |
[character] for which endpoint(s) the summary statistic should be output?
If |
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. |
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.
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.
Brice Ozenne
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.