funnel_plot: ninjaFunnel

View source: R/plotting-functions.R

funnel_plotR Documentation

ninjaFunnel

Description

This function is used for plotting funnel plots

Usage

funnel_plot(
  model,
  xlab = "Estimate",
  ylab = "Standard Error",
  font = "serif",
  CI = F,
  alpha = 0.6,
  shape = 19,
  size = 1.5,
  CI_linetype = "dashed",
  CI_size = 0.6,
  pool_linetype = "dotted",
  pool_size = 0.5,
  density = F
)

Arguments

model

an object belonging to the class 'meta_ninja'. These objects are created by the function 'meta3_moderation'.

xlab

a character string. Label for the x-axis.

ylab

a character string. Label for the y-axis.

font

a character string. Set's font family. Defaults to times new roman ('serif')

CI

a bool. If true, error bars will be plotted. totally unnecesary, but kind of fun.

alpha

a scalar. Sets alpha transparency.

shape

a scalar. The ggplot2 shape for the poitns

size

a scalar. The ggplot2 size value for the points

CI_linetype

ggplot2 linetype for confidence intervals

CI_size

ggplot2 size value for confidence intervals

pool_linetype

ggplot2 linetype for pooled estimate

pool_size

ggplot2 size value for pooled estimate

density

a bool. If True, plots densit of points.


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