metabolic (version 0.1.2)

plot_small_study_effects: Plot small-study effects analysis

Description

Plot small-study effects analysis

Usage

plot_small_study_effects(x, save = FALSE, path, format = ".png")

Value

a plot.

Arguments

x

an object of class meta

save

A boolean to indicate whether to save the plot to disk.

path

Path to write to. It has to be a character string indicating the path and file name (without the extension). For example, ~/Documents/small_study_effects will save small_study_effects.png to the Documents folder.

format

The file extension that you want to save the plot to. Only .png, is supported.

Examples

if (FALSE) {
  # Perform meta-analysis on VO2max
  results <- perform_meta(endpoint = "VO2max")

  # Plot small-study effects results
  results$meta_analysis$Overall %>%
     plot_small_study_effects()
}