Learn R Programming

forestplot (version 2.0.1)

prFpGetLabels: Gets the forestplot labels

Description

A function that gets all the labels

Usage

prFpGetLabels(label_type, labeltext, align, nc, nr, is.summary, txt_gp, col)

Value

list A list with length(nc) where each element contains a list of length(nr) elements with attributes width/height for each element and max_width/max_height for the total

Arguments

label_type

The type of text labels

labeltext

A list, matrix, vector or expression with the names of each row or the name of the column if using the *dplyr* select syntax - defaults to "labeltext". Note that when using `group_by` a separate labeltext is not allowed. The list should be wrapped in m x n number to resemble a matrix: list(list("rowname 1 col 1", "rowname 2 col 1"), list("r1c2", expression(beta)). You can also provide a matrix although this cannot have expressions by design: matrix(c("rowname 1 col 1", "rowname 2 col 1", "r1c2", "beta"), ncol = 2). Use NA:s for blank spaces and if you provide a full column with NA then that column is a empty column that adds some space. Note: If you do not provide the mean/lower/upper arguments the function expects the label text to be a matrix containing the labeltext in the rownames and then columns for mean, lower, and upper.

align

Alignment, should be equal to length(nc

nc

Number of columns

nr

Number of rows

is.summary

A vector indicating by TRUE/FALSE if the value is a summary value which means that it will have a different font-style

txt_gp

Set the fonts etc for all text elements. See fpTxtGp for details

col

Set the colors for all the elements. See fpColors for details