Skip to contents

Opens the metRscreen app for screening references by title and abstract in a meta-analysis or systematic review. Each reference is shown one at a time with your keywords highlighted in colour, and you record Accept, Reject (with a reason from your own list) or No Decision, plus an optional comment.

Decisions are saved after every click, next to the reference file, so you can close the app at any point and carry on later by running the same call. With collab.names, several people can screen the same file, each with their own saved decisions, and a combined summary flags where they agree and disagree.

Usage

metRscreen(
  screen.file,
  reject.list = NULL,
  collab.names = NULL,
  collab.split = "all",
  keywords = list(green = NULL, red = NULL, purple = NULL, orange = NULL, blue = NULL)
)

Arguments

screen.file

path to the csv (or .ris) file containing references you wish to screen. Can be absolute ("~/Desktop/refs.csv"), relative to the working directory ("data/refs.csv"), or built with here::here().

reject.list

list of rejection reasons to be added to metRscreen, can be left empty

collab.names

vector of screener names to switch on collaborative mode, can be left empty. Each screener gets their own files (<screen.file>_<name>_Screened.csv and <screen.file>_<name>_history.rds), you switch screener in the app, and other screeners' decisions can be shown or hidden. A combined <screen.file>_Collab_Summary.csv flags agreements and conflicts. Names are remembered, so later sessions can leave this empty or add new screeners.

collab.split

how papers are shared out in collaborative mode. "all" (the default): every screener screens every paper. 2: double screening, where every paper is screened by exactly two screeners, with papers spread evenly and at random across the team (useful for three or more screeners). The split is saved as <screen.file>_collab_assignment.csv and reused in later sessions, so it never reshuffles part-way through; each screener only sees the papers assigned to them.

keywords

takes a list of green, red, purple, orange, or blue keywords to add to the highlight word command.

Value

Called for its side effect of running the app; returns NULL invisibly. Decisions are saved as <screen.file>_Screened.csv (your original columns plus Screen, Reason, Comment and Screen.Name) and the session as <screen.file>_history.rds, both next to screen.file.

Examples

if (FALSE) { # \dontrun{
# A small set of example references ships with the package. Copy it
# somewhere writable first, because decisions are saved next to the file.
refs <- file.path(tempdir(), "Examples.csv")
file.copy(system.file("metRscreen", "www", "Examples.csv",
                      package = "metRscreen"), refs)

# Screen on your own
metRscreen(
  screen.file = refs,
  reject.list = c("no control", "wrong study system"),
  keywords    = list(green = c("old", "young"), red = c("parent*"))
)

# Screen as a team, with every paper seen by exactly two people
metRscreen(
  screen.file  = refs,
  collab.names = c("Ed", "Joel", "Krish"),
  collab.split = 2
)
} # }