HRtable.text: Function to compute and render text entries for HR-table

Description Usage Arguments Value Examples

View source: R/HRtable.R

Description

Function to compute and render text entries for HR-table

Usage

1
2
HRtable.text(this.data, this.outcome, this.var, this.type, sign.digits,
  sign.digits.HR, pvalue.digits, pvalue.cutoff, less.than.character)

Arguments

this.data

Data used for the computations

this.outcome

A text string as input for survival::coxph, e.g., "Surv(Follow_up_Years, Event_Death)" (incl. the quotes). This string will be passed to coxph as the left-side of the model equation with as.formula(paste(this.outcome, " ~ ", this.var, sep = ""))

this.var

Variable in the table (must exist in this.data)

this.type

Variable type for table

sign.digits

Digits used for parameter estimates

sign.digits.HR

Digits used for hazard ratios and conf. intervals

pvalue.digits

Digits used for p-values

pvalue.cutoff

Cutoff for changing p-values to simply 'smaller than', e.g., p < 0.001

less.than.character

The character to be prepended to the cutoff-value for the p-values (e.g., '< 0.001'). The default is less.than.character = "< " but it can be reset to any character string. If the result is passed on to html-rendering this symbol can be produced by less.than.character = "&lt; " (HTML-friendly name for 'less than' since '<' is used in HTML-tags and might not render correctly as a character; e.g., when using function htmlTable() in the htmlTable-package).

Value

Output used by HRtable()

Examples

1
## Not run:  Called by other function - not intended to be called by user directly. 

FrThomas/risyphus documentation built on Dec. 6, 2019, 6:27 a.m.