forest_plotFUN: Helper function to display a forestplot

View source: R/forest_plotFUN.R

forest_plotFUNR Documentation

Helper function to display a forestplot

Description

This code generates a helper function used in the wrappers "forestplot_eumelareg" and "forestplot_meta_eumelareg".

Usage

forest_plotFUN(
  toShow,
  main,
  y_breaks,
  cpositions,
  refLabel,
  point_size,
  fontsize,
  line_size,
  vjust_text,
  noDigits,
  ylim,
  varnames
)

Arguments

toShow

Results of a cox regression containing variable names, variable levels, hazards, confidence intervals and p-values, which will be converted to a forestplot.

main

title of the plot.

y_breaks

argument to supply manual y_breaks as a numerical vector. Default is NULL and breaks are set automatically within the function.

cpositions

relative positions of first three columns in the OX scale.

refLabel

label for reference levels of factor variables.

point_size

Size of mean points.

fontsize

relative size of annotations in the plot. Default value: 0.7.

line_size

Size of errorbar line.

vjust_text

vertical adjustment of text containing information about events, global pvalue, AIC and concordance index

noDigits

number of digits for estimates and p-values in the plot.

ylim

argument to supply manual y limits as numerical vector of length 2. Default is NULL and limits are set automatically within the function.

varnames

Character vector specifying rownames of the table (empty columns should be named with "").


MBender1992/emR documentation built on Feb. 18, 2025, 9:21 a.m.