Core

vivarium_inputs.core.get_data(entity, measure, location)

Parameters:

• measure (str) –

• location (str | int) –

vivarium_inputs.core.get_raw_incidence_rate(entity, location_id)

Parameters:

• entity (Cause | Sequela) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_incidence_rate(entity, location_id)

Parameters:

• entity (Cause | Sequela) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_prevalence(entity, location_id)

Parameters:

• entity (Cause | Sequela) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_birth_prevalence(entity, location_id)

Parameters:

• entity (Cause | Sequela) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_disability_weight(entity, location_id)

Parameters:

• entity (Cause | Sequela) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_remission_rate(entity, location_id)

Parameters:

• entity (Cause) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_cause_specific_mortality_rate(entity, location_id)

Parameters:

• entity (Cause) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_excess_mortality_rate(entity, location_id)

Parameters:

• entity (Cause) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_deaths(entity, location_id)

Parameters:

• entity (Cause) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_exposure(entity, location_id)

Parameters:

• entity (RiskFactor | AlternativeRiskFactor) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_exposure_standard_deviation(entity, location_id)

Parameters:

• entity (RiskFactor | AlternativeRiskFactor) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_exposure_distribution_weights(entity, location_id)

Parameters:

• entity (RiskFactor | AlternativeRiskFactor) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.filter_relative_risk_to_cause_restrictions(data)

It applies age restrictions according to affected causes and affected measures. If affected measure is incidence_rate, it applies the yld_age_restrictions. If affected measure is excess_mortality_rate, it applies the yll_age_restrictions to filter the relative_risk data

Parameters:

data (DataFrame) –

Return type:

DataFrame

vivarium_inputs.core.get_relative_risk(entity, location_id)

Parameters:

• entity (RiskFactor) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.filter_by_relative_risk(df, relative_risk)

Parameters:

• df (DataFrame) –

• relative_risk (DataFrame) –

Return type:

DataFrame

vivarium_inputs.core.get_population_attributable_fraction(entity, location_id)

Parameters:

• entity (RiskFactor | Etiology) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_estimate(entity, location_id)

Parameters:

• entity (Covariate) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_utilization_rate(entity, location_id)

Parameters:

• entity (HealthcareEntity) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_structure(entity, location_id)

Parameters:

• entity (Population) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_theoretical_minimum_risk_life_expectancy(entity, location_id)

Parameters:

• entity (Population) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_age_bins(entity, location_id)

Parameters:

• entity (Population) –

• location_id (int) –

Return type:

DataFrame

vivarium_inputs.core.get_demographic_dimensions(entity, location_id)

Parameters:

• entity (Population) –

• location_id (int) –

Return type:

DataFrame