PRISMAstatement (version 1.1.1)

prisma: Generate a PRISMA statement flow chart

Description

Generate PRISMA statement flow chart for use in retrospective medical research. Almost all arguments are mandatory, as they are in the recommended PRISMA statement.

Usage

prisma(found, found_other, no_dupes, screened, screen_exclusions,
  full_text, full_text_exclusions, qualitative, quantitative = NULL,
  labels = NULL, extra_dupes_box = FALSE, ..., dpi = 72,
  font_size = 10)
prisma_graph(found, found_other, no_dupes, screened, screen_exclusions,
  full_text, full_text_exclusions, qualitative, quantitative = NULL,
  labels = NULL, extra_dupes_box = FALSE, ..., dpi = 72,
  font_size = 10)

Arguments

found

Records found through database searching

found_other

Additional records identified through other sources

no_dupes

Records after duplicates removed

screened

Records screened

screen_exclusions

Records excluded

full_text

Full-text articles assessed for eligibility

full_text_exclusions

Full-text articles excluded with reasons

qualitative

Studies included in qualitative analysis

quantitative

Studies included in quantitative synthesis (meta-analysis)

labels

NULL is the default, but if a named list of character strings, the box matching each name will get the corresponding label. See examples.

extra_dupes_box

Single logical value, default is FALSE which corresponds to the example 2009 PRISMA Statement Flow Chart. If TRUE, then an additional box will be presented indicating the number of duplicates removed, calculated from the other numbers.

...

Further arguments are passed to grViz

dpi

Dots per inch, 72 is the default here, and in DiagrammeR itself it claims to be 96. Varying the DPI (which is done in the DOT file) unfortunately does not get detected by the downstream processing by the 'htmlwidgets' package. To overcome this, the user can add height and width arguments which are passed through. It is easy to for scaled graphs to fall off the canvas, or be crushed into the top-left corner, and unfortunately this requires trial and error. Increasing DPI over 72 with this setting tends to truncate the graph. On the other hand, leaving the DPI at 72 and increasing both height and width appears to consistently give higher resolution images.

font_size

integer font size in points, default is 10. DiagrammeR via htmlwidgets should scale the boxes to include the text no matter what size font is used. However, the heuristics are not perfect, so tweaking the font size here may help prepare for publication.

Functions

• prisma_graph: Generate the `dot` graph text

Examples

# NOT RUN {
prisma(1000, 20, 270, 270, 10, 260, 20, 240, 107)
prisma(1000, 20, 270, 270, 10, 260, 20, 240, 107,
       labels = list(found = "FOUND"))
prisma(1000, 20, 270, 270, 10, 260, 20, 240, 107, dpi = 24)
prisma(1000, 20, 270, 270, 10, 260, 20, 240, 107, extra_dupes_box = TRUE)
# vary the font size
prisma(1000, 20, 270, 270, 10, 260, 20, 240, 107, font_size = 6)
prisma(1000, 20, 270, 270, 10, 260, 20, 240, 107, font_size = 60)
# giving impossible numbers should cause an error
# }
# NOT RUN {
  prisma(1, 2, 3, 4, 5, 6, 7, 8, 9)
# giving unlikely numbers should cause a warning
  prisma(1000, 20, 270, 270, 10, 260, 19, 240, 107)
  prisma(1000, 20, 270, 270, 269, 260, 20, 240, 107)
# }