Utilities

This module contains utility classes and functions for use across vivarium_public_health components.

class vivarium_public_health.utilities.EntityString(entity)[source]

Convenience class for representing entities as strings.

property type
property name
split_entity()[source]
class vivarium_public_health.utilities.TargetString(target)[source]

Convenience class for representing risk targets as strings.

property type
property name
property measure
split_target()[source]
vivarium_public_health.utilities.to_snake_case(string)[source]
Return type:

str

Parameters:

string (str)

vivarium_public_health.utilities.to_time_delta(span_in_days)[source]
Parameters:

span_in_days (int | float | str)

vivarium_public_health.utilities.to_years(time)[source]

Converts a time delta to a float for years.

Return type:

float

Parameters:

time (Timedelta)

vivarium_public_health.utilities.is_non_zero(data)[source]
Return type:

bool

Parameters:

data (Iterable[SupportsFloat | Timedelta | timedelta | Timestamp | datetime] | SupportsFloat | Timedelta | timedelta | Timestamp | datetime | DataFrame)