riskCommunicator (version 1.0.1)

summary.gComp: Print a summary of a gComp class object.

Description

Takes a gComp object produced by gComp() and produces various useful summaries from it.

Usage

# S3 method for gComp
summary(object, ...)
# S3 method for summary.gComp
print(x, ...)

Arguments

object

(Required) An object of class gComp as produced by gComp().

...

Further arguments passed to or from other methods.

x

(Required) An object of class summary.gComp as produced by summary.gComp().

Value

Returns the formula, family (with link function), contrast evaluated, resulting point estimate and 95% confidence intervals of the parameters estimated, and the underlying glm used for model predictions.

Examples

# NOT RUN {
## Obtain the risk difference and risk ratio for cardiovascular disease or 
## death between patients with and without diabetes, while controlling for
## age, sex, BMI, whether the individual is currently a smoker, and 
## if they have a history of hypertension.
data(cvdd)
set.seed(4832)
diabetes.result <- gComp(cvdd, 
   formula = "cvd_dth ~ DIABETES + AGE + SEX + BMI + CURSMOKE + PREVHYP",
   outcome.type = "binary", R = 20)
summary(diabetes.result)

# }