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

Description Usage Arguments Value Examples

View source: R/BLtable.R

Description

Function to compute and render text entries for BL-table

Usage

1
2
3
table.text(this.data, this.var, group.var, this.GroupA, this.GroupB,
  this.type, this.test, sign.digits, sign.digits.prop, pvalue.digits,
  pvalue.cutoff, less.than.character)

Arguments

this.data

Data used for the computations

this.var

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

group.var

The name of the variable (column) in data that partitions the data set into two groups.

this.GroupA

Name (factor level) of 'Group A' in the table

this.GroupB

Name (factor level) of 'Group B' in the table

this.type

Variable type for table

this.test

Test that determines p-value

sign.digits

Digits used for mean, standard deviation, etc.

sign.digits.prop

Digits used for proportion of cases for factors.

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 BLtable()

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.