define_criteria: Define screening inclusion criteria

View source: R/criteria.R

define_criteriaR Documentation

Define screening inclusion criteria

Description

Bundles the human-readable inclusion criteria a review uses into an object that can be rendered into the paper's standard screening prompt.

Usage

define_criteria(
  scope,
  inclusions,
  exclusion_notes = NULL,
  clarifications = NULL
)

Arguments

scope

A one-sentence description of what the review is about. Used at the top of the LLM prompt so the model has orienting context.

inclusions

A character vector of numbered inclusion criteria. Order matters — criterion 1 is scored first, criterion n last.

exclusion_notes

Optional list of the same length as inclusions, giving per-criterion exclusion clarifications. NULL at any position means no notes for that criterion.

clarifications

Optional character vector of general clarifications (e.g. definitions of terms) rendered as a block after the criteria. NULL (the default) omits the block.

Value

An object of class screenllm_criteria.

Examples

criteria <- define_criteria(
  scope = "Field-based coral reef restoration and performance",
  inclusions = c(
    "The study is conducted at a field-based coral reef restoration site.",
    "The study describes a project with an explicit restoration goal.",
    "The study describes an active restoration intervention.",
    "The study monitors at least one restoration-performance metric."
  )
)
print(criteria)

screenllm documentation built on Sept. 24, 2026, 5:11 p.m.