Core

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

Pull raw GBD data for measure and entity.

This also sets all non-value columns to be the dataframe index.

Return type:

DataFrame

Parameters:

• entity (ModelableEntity) – Entity for which to pull measure.

• measure (str) – Measure for which to pull data, should be a measure available for the kind of entity which entity is.

• location (str | int | list[str | int]) – Location for which to pull data. This can be a location id as an int, the location name as a string, or a list of these two data types.

• years (int | str | list[int] | None) – Years for which to extract data. If None, get most recent year. If ‘all’, get all available data.

• data_type (DataType) – The DataType object for which to extract data.

Returns:

Raw and slightly reshaped data for the given entity, measure, location, and years.

vivarium_inputs.core.get_incidence_rate(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Cause | Sequela)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_raw_incidence_rate(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Cause | Sequela)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_prevalence(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Cause | Sequela)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_birth_prevalence(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Cause | Sequela)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_disability_weight(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Cause | Sequela)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_remission_rate(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Cause)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_cause_specific_mortality_rate(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Cause)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_excess_mortality_rate(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Cause)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_deaths(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Cause)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_exposure(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (RiskFactor | AlternativeRiskFactor)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_exposure_standard_deviation(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (RiskFactor | AlternativeRiskFactor)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_exposure_distribution_weights(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (RiskFactor | AlternativeRiskFactor)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_relative_risk(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (RiskFactor)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_population_attributable_fraction(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (RiskFactor | Etiology)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_estimate(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Covariate)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_structure(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Population)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_theoretical_minimum_risk_life_expectancy(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Population)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_age_bins(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Population)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)

vivarium_inputs.core.get_demographic_dimensions(entity, location_id, years, data_type)

Return type:

DataFrame

Parameters:

• entity (Population)

• location_id (list[int])

• years (int | str | list[int] | None)

• data_type (DataType)