API map

Curated map of the public API. Prefer the types below.

​

Start here

Guides: Quickstart · Which API?

​

Criteria (Cohort)

• db.enrollment.covering_index(...)
• db.demographic.age_at_index(...) / .sex(...) / .race(...)
• db.death.recorded(...)
• Coded rules: cohort.include(db.diagnosis.matching(...), window=...)

Plain-English glossary: Which API?.

​

Connectors and connection

See Connectors.

​

Errors

Public errors live under the EncodeboxError hierarchy in encodebox.render.errors.

​

Legacy (deprecated)

Still importable; each call warns. Prefer EventFrame / Cohort.

​

Advanced / internals

Rarely needed day-to-day:

• encodebox.coerce.to_ir — lower objects to IR
• encodebox.render — repr / explain / diagram helpers
• encodebox.frame.verbs — verb implementations (use EventFrame instead)