API reference

API reference

Full details on all Typhoidsim classes and functions.

calibration Define calibration helpers for ss.Calibration()
defaults Define some default values, constants for use throughout Typhoidsim
distributions Distributions, useful for vaccine waning parameterization
environment Define environments
immunity Immunity waning functions
ingest Functionality related to ingesting data from files. Ingesting encompasses
interventions Define Typhoid-specific treatments and diagnostics (interventions). It includes
monitors Define “passive” observation methods that do not interfere with the course
networks Custom network classes for direct transmission
patterns Classes that support introducing ‘pre-defined’
products Define Typhoid-specific products used with typhoid interventions.
settings Define options for Typhoidsim
typhoid Typhoid model.
utils General utilities
utils_eligibility A collection of commonly used eligibility criteria, wrapped in functions readu
utils_math Numerical and mathy utilities like math function that can be used
visualizers A collection of useful plotting functions that could eventually be part of some