make_xaxis: Create x-axis

View source: R/make-xaixs.R

make_xaxisR Documentation

Create x-axis

Description

This function used to x-axis for the forest plot.

Usage

make_xaxis(
  at,
  at_minor = NULL,
  xlab = NULL,
  x0 = 1,
  x_trans = "none",
  ticks_digits = 1,
  gp = gpar(),
  xlab_gp = NULL,
  xlim
)

Arguments

at

Numerical vector, create ticks at given values.

at_minor

Numerical vector, create ticks at given values without label.

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.

x0

Position of vertical line for 0 or 1.

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_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.

gp

Graphical parameters for arrow.

xlab_gp

Graphical parameters for xlab.

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.

Value

A grob


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