makeMSDDesc: Make a Column Description for Combined Mean and Standard...

In pmur002/metaplot: Meta-analysis Forest Plots

Description

The function produces descriptions that are used for making mean and standard deviation combined columns inside the newCols argument in the metaDF2Matrix() function.

Usage

makeMSDDesc(col1 = "mean", col2 = "sd",
            round = c(1, 2), brackets = c("(", ")"))

Arguments

col1	Column name for mean.
col2	Column name for standard deviation.
round	Numeric vector specyfying rounding for each column.
brackets	Character vector for the type of brackets to use on either side of the standard deviation.

Details

The column names are taken from the data frame of the "metaDF" object. It is a convenient 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

makeCIDesc, makeColDesc

Examples

makeMSDDesc("mean.e", "sd.e", c(1, 2), c(" (", ")"))

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