print.irates: Print method for 'irates' object

Description Usage Arguments Value See Also

View source: R/print.irates.R

Description

Print method for an object of class irates. By default it prints all competing events incidence rates contained in irates. It is also possible to select specific events or covariate values to be printed. Full sample incidence rates might also be printed.

Usage

1
2
## S3 method for class 'irates'
print(x, event.code = NULL, covar.code = NULL, full.sample = FALSE, display.digits = 4, ...)

Arguments

x

irates object

event.code

A character or numerical value that specifies the respective competing events for which the result of irates shall be printed. If NULL, event.code will be inherited from irates

covar.code

A character or numerical value that specifies the respective covariates value(s) for which the result of irates shall be printed. If NULL, covar.code will be inherited from irates

full.sample

A logical value that specifies if results of irates shall also be printed for the full sample, i.e., irrespective of any covariate value. Default is set to FALSE

display.digits

An integer value specifying the number of decimal place for all incidence rates that shall be printed. Default is set to 4

...

Other arguments for print method

Value

No value returned.

See Also

irates


compeir documentation built on May 2, 2019, 5:47 a.m.