Package 'PRISMA2020'

Read in PRISMA flow diagram data

Description

Read in a template CSV containing data for the flow diagram

Usage

PRISMA_data(data)

Arguments

data	File to read in.

Value

A list of objects needed to plot the flow diagram

Examples

csvFile <- system.file("extdata", "PRISMA.csv", package = "PRISMA2020")
data <- read.csv(csvFile);
data <- PRISMA_data(data);

---

Plot interactive flow diagrams for systematic reviews

Description

Produces a PRISMA2020 style flow diagram for systematic reviews, with the option to add interactivity through tooltips (mouseover popups) and hyperlink URLs to each box. Data can be imported from the standard CSV template provided.

Usage

PRISMA_flowdiagram(
  data,
  interactive = FALSE,
  previous = TRUE,
  other = TRUE,
  detail_databases = FALSE,
  detail_registers = FALSE,
  fontsize = 7,
  font = "Helvetica",
  title_colour = "Goldenrod1",
  greybox_colour = "Gainsboro",
  main_colour = "Black",
  arrow_colour = "Black",
  arrow_head = "normal",
  arrow_tail = "none",
  side_boxes = TRUE
)

Arguments

data	List of data inputs including numbers of studies, box text, tooltips, and urls for hyperlinks. Data inputted via the PRISMA_data() function. If inputting individually, see the necessary parameters listed in the PRISMA_data()) function and combine them in a list using data <- list().
interactive	Logical argument TRUE or FALSE whether to plot interactivity (tooltips and hyperlinked boxes).
previous	Logical argument (TRUE or FALSE) specifying whether previous studies were sought.
other	Logical argument (TRUE or FALSE) specifying whether other studies were sought.
detail_databases	Logical argument (TRUE or FALSE) specifying whether to list specific databases.
detail_registers	Logical argument (TRUE or FALSE) specifying whether to list specific registers.
fontsize	The font size for text in each box. The default is '12'.
font	The font for text in each box. The default is 'Helvetica'.
title_colour	The colour for the upper middle title box (new studies). The default is 'Goldenrod1'. See 'DiagrammeR' colour scheme. http://rich-iannone.github.io/DiagrammeR/graphviz_and_mermaid.html#colors.
greybox_colour	The colour for the left and right column boxes. The default is 'Gainsboro'. See 'DiagrammeR' colour scheme http://rich-iannone.github.io/DiagrammeR/graphviz_and_mermaid.html#colors.
main_colour	The colour for the main box borders. The default is 'Black'. See 'DiagrammeR' colour scheme http://rich-iannone.github.io/DiagrammeR/graphviz_and_mermaid.html#colors.
arrow_colour	The colour for the connecting lines. The default is 'Black'. See 'DiagrammeR' colour scheme http://rich-iannone.github.io/DiagrammeR/graphviz_and_mermaid.html#colors.
arrow_head	The head shape for the line connectors. The default is 'normal'. See DiagrammeR arrow shape specification http://rich-iannone.github.io/DiagrammeR/graphviz_and_mermaid.html#arrow-shapes. #nolint
arrow_tail	The tail shape for the line connectors. The default is 'none'. See DiagrammeR arrow shape specification http://rich-iannone.github.io/DiagrammeR/graphviz_and_mermaid.html#arrow-shapes. #nolint
side_boxes	Whether or not to include the blue label boxes along the side

Value

A flow diagram plot.

Examples

csvFile <- system.file("extdata", "PRISMA.csv", package = "PRISMA2020")
data <- read.csv(csvFile);
data <- PRISMA_data(data);
plot <- PRISMA_flowdiagram(data,
                fontsize = 12,
                interactive = TRUE,
                previous = FALSE,
                other = TRUE);
plot

---

Save PRISMA2020 flow diagram

Description

Save the output from PRISMA_flowdiagram() to the working directory.

Usage

PRISMA_save(
  plotobj,
  filename = "PRISMA2020_flowdiagram.html",
  filetype = NA,
  overwrite = FALSE
)

Arguments

plotobj	A plot produced using PRISMA_flowdiagram().
filename	The filename to save (including extension)
filetype	The filetype to save the plot in, supports: HTML, ZIP, PDF, PNG, SVG, PS and WEBP (if NA, the filetype will be calculated out based on the file extension) HTML files maintain hyperlinks and tooltips The ZIP option creates an archive containing the HTML file, alongside supporting javascript and css files in an adjacent folder, instead of embedded base64 within the HTML file
overwrite	if TRUE, will overwrite an existing file

Value

the absolute filename of the saved diagram plot.

Examples

csvFile <- system.file("extdata", "PRISMA.csv", package = "PRISMA2020")
data <- read.csv(csvFile);
data <- PRISMA_data(data);
plot <- PRISMA_flowdiagram(data,
                fontsize = 12,
                interactive = TRUE,
                previous = FALSE,
                other = TRUE);
PRISMA_save(plot, filename = tempfile(), filetype="html");

---

Defunct function - replaced by "PRISMA_data"

Description

Defunct function - replaced by "PRISMA_data"

Usage

read_PRISMAdata(data)

Arguments

data	File to read in.

See Also

PRISMA_data()

---

Defunct function - replaced by "PRISMA_interactive_"

Description

Defunct function - replaced by "PRISMA_interactive_"

Usage

sr_flow_interactive(plot, urls, previous, other)

Arguments

plot	A plot object from PRISMA_flowdiagram().
urls	A dataframe consisting of two columns: nodes and urls. The first column should contain 19 rows for the nodes from node1 to node19. The second column should contain a corresponding URL for each node.
previous	Logical argument (TRUE or FALSE) (supplied through PRISMA_flowdiagram()) specifying whether previous studies were sought.
other	Logical argument (TRUE or FALSE) (supplied through PRISMA_flowdiagram()) specifying whether other studies were sought.

See Also

PRISMA_interactive_()

---