forest_plot: ninjaForest

In JConigrave/msemtools: Routines, tables, and figures for metaSEM analyses

ninjaForest

Description

This function is used for plotting

Usage

forest_plot(
  model,
  ...,
  xlab = "Effect size",
  effect_label = NULL,
  transform = NULL,
  baseline_name = "Pooled estimate",
  factor.levels = NULL,
  facet_by = NULL,
  vline = NULL,
  author = NULL,
  year = NULL,
  order_magnitude = FALSE,
  include_weights = FALSE,
  moderator.shape = 23,
  moderator.size = 3,
  summary.shape = 23,
  summary.size = 4,
  diamond = TRUE,
  moderator_diamond = FALSE,
  font = "serif"
)

Arguments

model	an object belonging to the class 'meta_ninja'. These objects are created by the function 'meta3_moderation'.
...	moderators to plot character strings only
xlab	a string.
effect_label	a string. If provided relabels "effect size" in facetting.
transform	a function. If supplied effect sizes are transformed by this function
baseline_name	a string. The label for the baseline model
factor.levels	a character vector. If supplied, only the factor.levels specified will be plotted.
facet_by	a colname. Facets effect sizes by a supplied variable.
vline	a scalar. Dictates the x-intercept (the dashed line).
author	the name of the author column
year	the name of the year column
order_magnitude	a bool. If true, effect sizes are ordered by magnitude
include_weights	a bool. If true, effect sizes become transparent proportional to their weight
moderator.shape	a scalar ggplot2 geom_point shape value
moderator.size	a scalar. ggplot2 geom_point size value
summary.shape	a scalar ggplot2 geom_point shape value
summary.size	a scalar ggplot2 geom_point size value
diamond	a bool. If true, diamond is created for summary measure
moderator_diamond	a bool. If true, diamond is created for moderators
font	A string. The name of a font family. Defaults to serif

JConigrave/msemtools documentation built on Aug. 10, 2022, 12:09 p.m.