API reference

The public API is exported from prismaflow.

Core model

  • PrismaFlow
  • FlowMetadata
  • new_review

Stage models

  • IdentificationStage
  • ScreeningStage
  • EligibilityStage
  • IncludedStage

Enums

  • PrismaTemplate

Validation

  • ValidationReport
  • ValidationMessage
  • validate_flow

Exceptions

  • PrismaFlowError
  • PrismaValidationError
  • TemplateNotSupportedError
  • OptionalDependencyError

Common methods

Method Description
new_review(...) Create a PRISMA 2020 new-review flow from flat count arguments.
PrismaFlow(...) Create a flow from nested stage models.
PrismaFlow.new_review(...) Compatibility factory for a PRISMA 2020 new-review flow.
flow.validate() Return a structured validation report.
flow.to_svg(path=None) Render SVG text and optionally write a file.
flow._repr_svg_() Return SVG for inline notebook display.
flow._repr_mimebundle_() Return an SVG MIME bundle for notebook frontends.
flow.to_html(path=None) Render standalone HTML and optionally write a file.
flow.to_mermaid(path=None) Render Mermaid text and optionally write a file.
flow.to_png(path=None) Render PNG bytes and optionally write a file.
flow.to_json(path=None) Serialize JSON and optionally write a file.
PrismaFlow.from_json(source) Load a flow from JSON text or a JSON path.