check_errors: Checking error for forest plot

In forestploter: Create a Flexible Forest Plot

Checking error for forest plot

Description

Checking error for forest plot

Usage

check_errors(
  data,
  est,
  lower,
  upper,
  sizes,
  ref_line,
  vert_line,
  ci_column,
  is_summary,
  xlim,
  x_trans,
  ticks_at,
  ticks_digits,
  ticks_minor,
  title,
  arrow_lab,
  xlab
)

Arguments

data	Data to be displayed in the forest plot
est	Point estimation. Can be a list for multiple columns and/or multiple groups. If the length of the list is larger than then length of ci_column, then the values reused for each column and considered as different groups.
lower	Lower bound of the confidence interval, same as est.
upper	Upper bound of the confidence interval, same as est.
sizes	Size of the point estimation box, can be a unit, vector or a list. Values will be used as it is, no transformation will be applied.
ref_line	X-axis coordinates of zero line, default is 1. Provide an atomic vector if different reference line for each ci_column is desired.
vert_line	Numerical vector, add additional vertical line at given value. Provide a list of numerical vector element if different vertical line for each ci_column is desired.
ci_column	Column number of the data the CI will be displayed.
is_summary	A logical vector indicating if the value is a summary value, which will have a diamond shape for the estimate. Can not be used with multiple group forestplot.
xlim	Limits for the x axis as a vector of length 2, i.e. c(low, high). It will take the minimum and maximum of the lower and upper value if not provided. This will apply to all CI columns if provided, and will be calculated automatically for each column if not provided. This should be a list with the same length of ci_column if different xlim for different column is desired.
x_trans	Change axis scale, Allowed values are one of c("none", "log", "log2", "log10"). Default is "none", no transformation will be applied. The formatted label will be used for scale = "log2" or "log10", change this in x_trans. Set this to "log" if x-axis tick marks assume values are exponential, e.g. for logistic regression (OR), survival estimates (HR), Poisson regression etc.
ticks_at	Set X-axis tick-marks point. This will apply to all CI columns if provided, and will be calculated automatically for each column if not provided. This should be a list if different ticks_at for different column is desired. Although many efforts have been made to automatically get a pretty ticks break, it will not give a perfect solution, especially if 'log2' and 'log10' defined for x_trans. Please provide this value if possible.
ticks_digits	Number of digits for the x-axis, default is NULL to calculate an integer based on ticks_at if provided or lower and upper if not. This should be a numerical vector if different rounding will be applied to different column. If an integer is specified, for example 1L, trailing zeros after the decimal mark will be dropped. Specify numeric, for example 1, to keep the trailing zero after the decimal mark.
ticks_minor	A numeric vector of positions to draw ticks without labels (optional). The values provided here can be superset or disjoint sets of ticks_at.
title	The text for the title.
arrow_lab	Labels for the arrows, string vector of length two (left and right). The theme of arrow will inherit from the x-axis. This should be a list if different arrow labels for each column is desired.
xlab	X-axis labels, it will be put under the x-axis. An atomic vector should be provided if different xlab for different column is desired.

forestploter documentation built on May 29, 2024, 5:48 a.m.