metagear (version 0.7)

plot_PRISMA: Plots and creates a PRISMA flow diagram.

Description

Creates a PRISMA (Preferred Reporting Items for Systematic Reviews and Meta-Analyses) flow diagram depicting the 'flow' of study inclusions and exclusions during various systematic review phases. It is meant to describe the number of studies identified, included, excluded, reasons for inclusion/exclusions, and final number of studies used in the meta-analysis. NOTE: currently only supports two start phases, and final phase must not have an exclude branch.

Usage

plot_PRISMA(
  aPhaseVector,
  colWidth = 30,
  excludeDistance = 0.8,
  design = "classic",
  hide = FALSE
)

Arguments

aPhaseVector

A vector of ordered labels (strings) for each phase of the PRISMA diagram. Labels designating the beginning of the diagram are commented with "START_PHASE: " and those designating exclusion phases "EXCLUDE_PHASE: ". These comments will be removed from the diagram.

colWidth

An optional value (integer) designating the width of the text box of each phase.

excludeDistance

An optional value designating the the distance of exclude phase box from the main flow diagram. Larger values (> 0.8) increase this distance.

design

Designates the colorscheme and design of the the flow diagram. The default is classic (as in versions of metagear prior to v. 0.4). Others schemes are also available with color and more flat designs, and these can be further customized; see NOTE below for these details.

hide

When FALSE, the PRISMA flow diagram is not plotted.

Value

a grid object (grob) list

References

Moher, D., Liberati, A., Tetzlaff, J. and Altman, D.G., PRISMA Group. (2009) Preferred reporting items for systematic reviews and meta-analyses: the PRISMA statement. BMJ 339, b2535.

Examples

# NOT RUN {
phases <- c("START_PHASE: # of studies identified through database searching",
            "START_PHASE: # of additional studies identified through other sources",
            "# of studies after duplicates removed",
            "# of studies with title and abstract screened",
            "EXCLUDE_PHASE: # of studies excluded",
            "# of full-text articles assessed for eligibility",
            "EXCLUDE_PHASE: # of full-text excluded, not fitting eligibility criteria",
            "# of studies included in qualitative synthesis",
            "EXCLUDE_PHASE: # studies excluded, incomplete data reported",
            "final # of studies included in quantitative synthesis (meta-analysis)")
plot_PRISMA(phases, design = "cinnamonMint")

# }