calcWO.formula: Win odds calculation using formula syntax

View source: R/calcWO_formula.R

calcWO.formulaR Documentation

Win odds calculation using formula syntax

Description

Win odds calculation using formula syntax

Usage

## S3 method for class 'formula'
calcWO(x, data, ...)

Arguments

x

an object of class formula.

data

a data frame.

...

additional parameters.

Value

a data frame containing the win odds and its confidence interval. It contains the following columns:

  • WO calculated win odds.

  • LCL lower confidence limit.

  • UCL upper confidence limit.

  • SE standard error of the win odds.

  • WOnull win odds of the null hypothesis (specified in the WOnull argument).

  • alpha two-sided significance level for calculating the confidence interval (specified in the alpha argument).

  • Pvalue p-value associated with testing the null hypothesis.

  • WP calculated win probability.

  • WP_SE standard error of the win probability.

  • WP_SD standard deviation of the win probability, calculated as WP_SE multiplied by sqrt(N).

  • N total number of patients in the analysis.

  • formula returning the specified formula in the x argument.

  • ref showing how the reference group was selected. Can be modifying by specifying the ref argument.

References

Gasparyan SB et al. "Adjusted win ratio with stratification: calculation methods and interpretation." Statistical Methods in Medical Research 30.2 (2021): 580-611. doi:10.1177/0962280220942558

See Also

calcWO(), calcWO.hce(), calcWO.data.frame().

Examples

#Example 1
data(HCE1)
calcWO(AVAL ~ TRTP, data = HCE1)

#Example 2
calcWO(data = COVID19, GROUP ~ TRTP, ref = "Placebo")


hce documentation built on Oct. 16, 2024, 9:06 a.m.