Julia Package


Supported Platforms

Installation

Install the PrismAId package using Julia’s package manager:

using Pkg
Pkg.add("PrismAId")

Use

Access all prismAId tools from Julia:

using PrismAId

# Run screening on manuscripts
screening_config = read("screening.toml", String)
PrismAId.screening(screening_config)

# Download papers from Zotero
zotero_config = read("zotero.toml", String)
PrismAId.download_zotero(zotero_config)

# Download from URL list
PrismAId.download_url_list("urls.txt")

# Convert files to text
PrismAId.convert("./papers", "pdf,docx,html")

# Convert with Tika OCR fallback
PrismAId.convert("./papers", "pdf", "localhost:9998")

# OCR-only for PDFs
PrismAId.convert("./papers", "pdf", "localhost:9998", "", true)

# Run a systematic review
toml_config = read("project.toml", String)
PrismAId.run_review(toml_config)  # Correct function name

# Validate a configuration without executing it
# config type is one of "review", "screening", or "zotero"
PrismAId.validate_config("review", toml_config)

# Check a RevAIse review record against a reporting protocol (returns a JSON string)
report = PrismAId.check_conformance(record_json, "prisma-2020")

# Get a protocol's full requirement checklist, to plan a conforming review
guidance = PrismAId.protocol_guidance("prisma-2020")

See Protocol Conformance and Protocol Guidance for what these do.