Disability Observer

This module contains tools for observing years lived with disability (YLDs) in the simulation.

class vivarium_public_health.metrics.disability.DisabilityObserver

Counts years lived with disability.

By default, this counts both aggregate and cause-specific years lived with disability over the full course of the simulation.

In the model specification, your configuration for this component should be specified as, e.g.:

configuration:
    observers:
        disability:
            exclude:
                - "sex"
            include:
                - "sample_stratification"

CONFIGURATION_DEFAULTS: Dict[str, Any] = {'stratification': {'disability': {'exclude': [], 'include': []}}}

A dictionary containing the defaults for any configurations managed by this component. An empty dictionary indicates no managed configurations.

property disease_classes: List

setup(builder)

Defines custom actions this component needs to run during the setup lifecycle phase.

This method is intended to be overridden by subclasses to perform any necessary setup operations specific to the component. By default, it does nothing.

Parameters:

builder (Builder) – The builder object used to set up the component.

Return type:

None

get_disability_weight_pipeline(builder)

Parameters:

builder (Builder) –

Return type:

Pipeline

disability_weight_aggregator(dw)

Parameters:

dw (DataFrame) –

Return type:

float