makeCIDesc: Make a Column Description for Confidence Intervals

In pmur002/metaplot: Meta-analysis Forest Plots

Description

The function produces descriptions that are used for making confidence interval columns inside the newCols argument in the metaDF2Matrix() function.

Usage

makeCIDesc(col1 = "lower", col2 = "upper", round = 2,
           brackets = c("[", "]"), sep=", ")

Arguments

col1	Lower bound column name.
col2	Upper bound column name.
round	Rounding to nearest decimal for both columns.
brackets	Character vector for the type of brackets to use on either side of the numbers.
sep	Character to seperate the two numbers.

Details

The column names are taken from the data frame of the 'metaDF' object. It is a convenience function for specifying the new column format within the metaDF2Matrix() function.

Value

An object of class 'coldesc' with a list of following components:

format	A format string
colnames	A character vector of column names

See Also

makeMSDDesc, makeColDesc

Examples

makeCIDesc("lower", "upper", 2, c("[", "]"))
makeCIDesc("lower", "upper", 2, c("[", "]"), sep = " to ")

pmur002/metaplot documentation built on May 25, 2019, 10:21 a.m.