Utilities

Errors and utility functions for input processing.

vivarium_inputs.utilities.scrub_gbd_conventions(data, location)[source]
vivarium_inputs.utilities.scrub_location(data, location)[source]
vivarium_inputs.utilities.scrub_sex(data)[source]
vivarium_inputs.utilities.scrub_age(data)[source]
vivarium_inputs.utilities.scrub_year(data)[source]
vivarium_inputs.utilities.scrub_affected_entity(data)[source]
vivarium_inputs.utilities.set_age_interval(data)[source]
vivarium_inputs.utilities.normalize(data, fill_value=None, cols_to_fill=['draw_0', 'draw_1', 'draw_2', 'draw_3', 'draw_4', 'draw_5', 'draw_6', 'draw_7', 'draw_8', 'draw_9', 'draw_10', 'draw_11', 'draw_12', 'draw_13', 'draw_14', 'draw_15', 'draw_16', 'draw_17', 'draw_18', 'draw_19', 'draw_20', 'draw_21', 'draw_22', 'draw_23', 'draw_24', 'draw_25', 'draw_26', 'draw_27', 'draw_28', 'draw_29', 'draw_30', 'draw_31', 'draw_32', 'draw_33', 'draw_34', 'draw_35', 'draw_36', 'draw_37', 'draw_38', 'draw_39', 'draw_40', 'draw_41', 'draw_42', 'draw_43', 'draw_44', 'draw_45', 'draw_46', 'draw_47', 'draw_48', 'draw_49', 'draw_50', 'draw_51', 'draw_52', 'draw_53', 'draw_54', 'draw_55', 'draw_56', 'draw_57', 'draw_58', 'draw_59', 'draw_60', 'draw_61', 'draw_62', 'draw_63', 'draw_64', 'draw_65', 'draw_66', 'draw_67', 'draw_68', 'draw_69', 'draw_70', 'draw_71', 'draw_72', 'draw_73', 'draw_74', 'draw_75', 'draw_76', 'draw_77', 'draw_78', 'draw_79', 'draw_80', 'draw_81', 'draw_82', 'draw_83', 'draw_84', 'draw_85', 'draw_86', 'draw_87', 'draw_88', 'draw_89', 'draw_90', 'draw_91', 'draw_92', 'draw_93', 'draw_94', 'draw_95', 'draw_96', 'draw_97', 'draw_98', 'draw_99', 'draw_100', 'draw_101', 'draw_102', 'draw_103', 'draw_104', 'draw_105', 'draw_106', 'draw_107', 'draw_108', 'draw_109', 'draw_110', 'draw_111', 'draw_112', 'draw_113', 'draw_114', 'draw_115', 'draw_116', 'draw_117', 'draw_118', 'draw_119', 'draw_120', 'draw_121', 'draw_122', 'draw_123', 'draw_124', 'draw_125', 'draw_126', 'draw_127', 'draw_128', 'draw_129', 'draw_130', 'draw_131', 'draw_132', 'draw_133', 'draw_134', 'draw_135', 'draw_136', 'draw_137', 'draw_138', 'draw_139', 'draw_140', 'draw_141', 'draw_142', 'draw_143', 'draw_144', 'draw_145', 'draw_146', 'draw_147', 'draw_148', 'draw_149', 'draw_150', 'draw_151', 'draw_152', 'draw_153', 'draw_154', 'draw_155', 'draw_156', 'draw_157', 'draw_158', 'draw_159', 'draw_160', 'draw_161', 'draw_162', 'draw_163', 'draw_164', 'draw_165', 'draw_166', 'draw_167', 'draw_168', 'draw_169', 'draw_170', 'draw_171', 'draw_172', 'draw_173', 'draw_174', 'draw_175', 'draw_176', 'draw_177', 'draw_178', 'draw_179', 'draw_180', 'draw_181', 'draw_182', 'draw_183', 'draw_184', 'draw_185', 'draw_186', 'draw_187', 'draw_188', 'draw_189', 'draw_190', 'draw_191', 'draw_192', 'draw_193', 'draw_194', 'draw_195', 'draw_196', 'draw_197', 'draw_198', 'draw_199', 'draw_200', 'draw_201', 'draw_202', 'draw_203', 'draw_204', 'draw_205', 'draw_206', 'draw_207', 'draw_208', 'draw_209', 'draw_210', 'draw_211', 'draw_212', 'draw_213', 'draw_214', 'draw_215', 'draw_216', 'draw_217', 'draw_218', 'draw_219', 'draw_220', 'draw_221', 'draw_222', 'draw_223', 'draw_224', 'draw_225', 'draw_226', 'draw_227', 'draw_228', 'draw_229', 'draw_230', 'draw_231', 'draw_232', 'draw_233', 'draw_234', 'draw_235', 'draw_236', 'draw_237', 'draw_238', 'draw_239', 'draw_240', 'draw_241', 'draw_242', 'draw_243', 'draw_244', 'draw_245', 'draw_246', 'draw_247', 'draw_248', 'draw_249', 'draw_250', 'draw_251', 'draw_252', 'draw_253', 'draw_254', 'draw_255', 'draw_256', 'draw_257', 'draw_258', 'draw_259', 'draw_260', 'draw_261', 'draw_262', 'draw_263', 'draw_264', 'draw_265', 'draw_266', 'draw_267', 'draw_268', 'draw_269', 'draw_270', 'draw_271', 'draw_272', 'draw_273', 'draw_274', 'draw_275', 'draw_276', 'draw_277', 'draw_278', 'draw_279', 'draw_280', 'draw_281', 'draw_282', 'draw_283', 'draw_284', 'draw_285', 'draw_286', 'draw_287', 'draw_288', 'draw_289', 'draw_290', 'draw_291', 'draw_292', 'draw_293', 'draw_294', 'draw_295', 'draw_296', 'draw_297', 'draw_298', 'draw_299', 'draw_300', 'draw_301', 'draw_302', 'draw_303', 'draw_304', 'draw_305', 'draw_306', 'draw_307', 'draw_308', 'draw_309', 'draw_310', 'draw_311', 'draw_312', 'draw_313', 'draw_314', 'draw_315', 'draw_316', 'draw_317', 'draw_318', 'draw_319', 'draw_320', 'draw_321', 'draw_322', 'draw_323', 'draw_324', 'draw_325', 'draw_326', 'draw_327', 'draw_328', 'draw_329', 'draw_330', 'draw_331', 'draw_332', 'draw_333', 'draw_334', 'draw_335', 'draw_336', 'draw_337', 'draw_338', 'draw_339', 'draw_340', 'draw_341', 'draw_342', 'draw_343', 'draw_344', 'draw_345', 'draw_346', 'draw_347', 'draw_348', 'draw_349', 'draw_350', 'draw_351', 'draw_352', 'draw_353', 'draw_354', 'draw_355', 'draw_356', 'draw_357', 'draw_358', 'draw_359', 'draw_360', 'draw_361', 'draw_362', 'draw_363', 'draw_364', 'draw_365', 'draw_366', 'draw_367', 'draw_368', 'draw_369', 'draw_370', 'draw_371', 'draw_372', 'draw_373', 'draw_374', 'draw_375', 'draw_376', 'draw_377', 'draw_378', 'draw_379', 'draw_380', 'draw_381', 'draw_382', 'draw_383', 'draw_384', 'draw_385', 'draw_386', 'draw_387', 'draw_388', 'draw_389', 'draw_390', 'draw_391', 'draw_392', 'draw_393', 'draw_394', 'draw_395', 'draw_396', 'draw_397', 'draw_398', 'draw_399', 'draw_400', 'draw_401', 'draw_402', 'draw_403', 'draw_404', 'draw_405', 'draw_406', 'draw_407', 'draw_408', 'draw_409', 'draw_410', 'draw_411', 'draw_412', 'draw_413', 'draw_414', 'draw_415', 'draw_416', 'draw_417', 'draw_418', 'draw_419', 'draw_420', 'draw_421', 'draw_422', 'draw_423', 'draw_424', 'draw_425', 'draw_426', 'draw_427', 'draw_428', 'draw_429', 'draw_430', 'draw_431', 'draw_432', 'draw_433', 'draw_434', 'draw_435', 'draw_436', 'draw_437', 'draw_438', 'draw_439', 'draw_440', 'draw_441', 'draw_442', 'draw_443', 'draw_444', 'draw_445', 'draw_446', 'draw_447', 'draw_448', 'draw_449', 'draw_450', 'draw_451', 'draw_452', 'draw_453', 'draw_454', 'draw_455', 'draw_456', 'draw_457', 'draw_458', 'draw_459', 'draw_460', 'draw_461', 'draw_462', 'draw_463', 'draw_464', 'draw_465', 'draw_466', 'draw_467', 'draw_468', 'draw_469', 'draw_470', 'draw_471', 'draw_472', 'draw_473', 'draw_474', 'draw_475', 'draw_476', 'draw_477', 'draw_478', 'draw_479', 'draw_480', 'draw_481', 'draw_482', 'draw_483', 'draw_484', 'draw_485', 'draw_486', 'draw_487', 'draw_488', 'draw_489', 'draw_490', 'draw_491', 'draw_492', 'draw_493', 'draw_494', 'draw_495', 'draw_496', 'draw_497', 'draw_498', 'draw_499', 'draw_500', 'draw_501', 'draw_502', 'draw_503', 'draw_504', 'draw_505', 'draw_506', 'draw_507', 'draw_508', 'draw_509', 'draw_510', 'draw_511', 'draw_512', 'draw_513', 'draw_514', 'draw_515', 'draw_516', 'draw_517', 'draw_518', 'draw_519', 'draw_520', 'draw_521', 'draw_522', 'draw_523', 'draw_524', 'draw_525', 'draw_526', 'draw_527', 'draw_528', 'draw_529', 'draw_530', 'draw_531', 'draw_532', 'draw_533', 'draw_534', 'draw_535', 'draw_536', 'draw_537', 'draw_538', 'draw_539', 'draw_540', 'draw_541', 'draw_542', 'draw_543', 'draw_544', 'draw_545', 'draw_546', 'draw_547', 'draw_548', 'draw_549', 'draw_550', 'draw_551', 'draw_552', 'draw_553', 'draw_554', 'draw_555', 'draw_556', 'draw_557', 'draw_558', 'draw_559', 'draw_560', 'draw_561', 'draw_562', 'draw_563', 'draw_564', 'draw_565', 'draw_566', 'draw_567', 'draw_568', 'draw_569', 'draw_570', 'draw_571', 'draw_572', 'draw_573', 'draw_574', 'draw_575', 'draw_576', 'draw_577', 'draw_578', 'draw_579', 'draw_580', 'draw_581', 'draw_582', 'draw_583', 'draw_584', 'draw_585', 'draw_586', 'draw_587', 'draw_588', 'draw_589', 'draw_590', 'draw_591', 'draw_592', 'draw_593', 'draw_594', 'draw_595', 'draw_596', 'draw_597', 'draw_598', 'draw_599', 'draw_600', 'draw_601', 'draw_602', 'draw_603', 'draw_604', 'draw_605', 'draw_606', 'draw_607', 'draw_608', 'draw_609', 'draw_610', 'draw_611', 'draw_612', 'draw_613', 'draw_614', 'draw_615', 'draw_616', 'draw_617', 'draw_618', 'draw_619', 'draw_620', 'draw_621', 'draw_622', 'draw_623', 'draw_624', 'draw_625', 'draw_626', 'draw_627', 'draw_628', 'draw_629', 'draw_630', 'draw_631', 'draw_632', 'draw_633', 'draw_634', 'draw_635', 'draw_636', 'draw_637', 'draw_638', 'draw_639', 'draw_640', 'draw_641', 'draw_642', 'draw_643', 'draw_644', 'draw_645', 'draw_646', 'draw_647', 'draw_648', 'draw_649', 'draw_650', 'draw_651', 'draw_652', 'draw_653', 'draw_654', 'draw_655', 'draw_656', 'draw_657', 'draw_658', 'draw_659', 'draw_660', 'draw_661', 'draw_662', 'draw_663', 'draw_664', 'draw_665', 'draw_666', 'draw_667', 'draw_668', 'draw_669', 'draw_670', 'draw_671', 'draw_672', 'draw_673', 'draw_674', 'draw_675', 'draw_676', 'draw_677', 'draw_678', 'draw_679', 'draw_680', 'draw_681', 'draw_682', 'draw_683', 'draw_684', 'draw_685', 'draw_686', 'draw_687', 'draw_688', 'draw_689', 'draw_690', 'draw_691', 'draw_692', 'draw_693', 'draw_694', 'draw_695', 'draw_696', 'draw_697', 'draw_698', 'draw_699', 'draw_700', 'draw_701', 'draw_702', 'draw_703', 'draw_704', 'draw_705', 'draw_706', 'draw_707', 'draw_708', 'draw_709', 'draw_710', 'draw_711', 'draw_712', 'draw_713', 'draw_714', 'draw_715', 'draw_716', 'draw_717', 'draw_718', 'draw_719', 'draw_720', 'draw_721', 'draw_722', 'draw_723', 'draw_724', 'draw_725', 'draw_726', 'draw_727', 'draw_728', 'draw_729', 'draw_730', 'draw_731', 'draw_732', 'draw_733', 'draw_734', 'draw_735', 'draw_736', 'draw_737', 'draw_738', 'draw_739', 'draw_740', 'draw_741', 'draw_742', 'draw_743', 'draw_744', 'draw_745', 'draw_746', 'draw_747', 'draw_748', 'draw_749', 'draw_750', 'draw_751', 'draw_752', 'draw_753', 'draw_754', 'draw_755', 'draw_756', 'draw_757', 'draw_758', 'draw_759', 'draw_760', 'draw_761', 'draw_762', 'draw_763', 'draw_764', 'draw_765', 'draw_766', 'draw_767', 'draw_768', 'draw_769', 'draw_770', 'draw_771', 'draw_772', 'draw_773', 'draw_774', 'draw_775', 'draw_776', 'draw_777', 'draw_778', 'draw_779', 'draw_780', 'draw_781', 'draw_782', 'draw_783', 'draw_784', 'draw_785', 'draw_786', 'draw_787', 'draw_788', 'draw_789', 'draw_790', 'draw_791', 'draw_792', 'draw_793', 'draw_794', 'draw_795', 'draw_796', 'draw_797', 'draw_798', 'draw_799', 'draw_800', 'draw_801', 'draw_802', 'draw_803', 'draw_804', 'draw_805', 'draw_806', 'draw_807', 'draw_808', 'draw_809', 'draw_810', 'draw_811', 'draw_812', 'draw_813', 'draw_814', 'draw_815', 'draw_816', 'draw_817', 'draw_818', 'draw_819', 'draw_820', 'draw_821', 'draw_822', 'draw_823', 'draw_824', 'draw_825', 'draw_826', 'draw_827', 'draw_828', 'draw_829', 'draw_830', 'draw_831', 'draw_832', 'draw_833', 'draw_834', 'draw_835', 'draw_836', 'draw_837', 'draw_838', 'draw_839', 'draw_840', 'draw_841', 'draw_842', 'draw_843', 'draw_844', 'draw_845', 'draw_846', 'draw_847', 'draw_848', 'draw_849', 'draw_850', 'draw_851', 'draw_852', 'draw_853', 'draw_854', 'draw_855', 'draw_856', 'draw_857', 'draw_858', 'draw_859', 'draw_860', 'draw_861', 'draw_862', 'draw_863', 'draw_864', 'draw_865', 'draw_866', 'draw_867', 'draw_868', 'draw_869', 'draw_870', 'draw_871', 'draw_872', 'draw_873', 'draw_874', 'draw_875', 'draw_876', 'draw_877', 'draw_878', 'draw_879', 'draw_880', 'draw_881', 'draw_882', 'draw_883', 'draw_884', 'draw_885', 'draw_886', 'draw_887', 'draw_888', 'draw_889', 'draw_890', 'draw_891', 'draw_892', 'draw_893', 'draw_894', 'draw_895', 'draw_896', 'draw_897', 'draw_898', 'draw_899', 'draw_900', 'draw_901', 'draw_902', 'draw_903', 'draw_904', 'draw_905', 'draw_906', 'draw_907', 'draw_908', 'draw_909', 'draw_910', 'draw_911', 'draw_912', 'draw_913', 'draw_914', 'draw_915', 'draw_916', 'draw_917', 'draw_918', 'draw_919', 'draw_920', 'draw_921', 'draw_922', 'draw_923', 'draw_924', 'draw_925', 'draw_926', 'draw_927', 'draw_928', 'draw_929', 'draw_930', 'draw_931', 'draw_932', 'draw_933', 'draw_934', 'draw_935', 'draw_936', 'draw_937', 'draw_938', 'draw_939', 'draw_940', 'draw_941', 'draw_942', 'draw_943', 'draw_944', 'draw_945', 'draw_946', 'draw_947', 'draw_948', 'draw_949', 'draw_950', 'draw_951', 'draw_952', 'draw_953', 'draw_954', 'draw_955', 'draw_956', 'draw_957', 'draw_958', 'draw_959', 'draw_960', 'draw_961', 'draw_962', 'draw_963', 'draw_964', 'draw_965', 'draw_966', 'draw_967', 'draw_968', 'draw_969', 'draw_970', 'draw_971', 'draw_972', 'draw_973', 'draw_974', 'draw_975', 'draw_976', 'draw_977', 'draw_978', 'draw_979', 'draw_980', 'draw_981', 'draw_982', 'draw_983', 'draw_984', 'draw_985', 'draw_986', 'draw_987', 'draw_988', 'draw_989', 'draw_990', 'draw_991', 'draw_992', 'draw_993', 'draw_994', 'draw_995', 'draw_996', 'draw_997', 'draw_998', 'draw_999'])[source]
Parameters:
Return type:

DataFrame

vivarium_inputs.utilities.normalize_sex(data, fill_value, cols_to_fill)[source]
Parameters:

data (DataFrame) –

Return type:

DataFrame

vivarium_inputs.utilities.normalize_year(data)[source]
Parameters:

data (DataFrame) –

Return type:

DataFrame

vivarium_inputs.utilities.interpolate_year(data)[source]
vivarium_inputs.utilities.normalize_age(data, fill_value, cols_to_fill)[source]
Parameters:
Return type:

DataFrame

vivarium_inputs.utilities.get_ordered_index_cols(data_columns)[source]
Parameters:

data_columns (Index | set) –

vivarium_inputs.utilities.reshape(data, value_cols=['draw_0', 'draw_1', 'draw_2', 'draw_3', 'draw_4', 'draw_5', 'draw_6', 'draw_7', 'draw_8', 'draw_9', 'draw_10', 'draw_11', 'draw_12', 'draw_13', 'draw_14', 'draw_15', 'draw_16', 'draw_17', 'draw_18', 'draw_19', 'draw_20', 'draw_21', 'draw_22', 'draw_23', 'draw_24', 'draw_25', 'draw_26', 'draw_27', 'draw_28', 'draw_29', 'draw_30', 'draw_31', 'draw_32', 'draw_33', 'draw_34', 'draw_35', 'draw_36', 'draw_37', 'draw_38', 'draw_39', 'draw_40', 'draw_41', 'draw_42', 'draw_43', 'draw_44', 'draw_45', 'draw_46', 'draw_47', 'draw_48', 'draw_49', 'draw_50', 'draw_51', 'draw_52', 'draw_53', 'draw_54', 'draw_55', 'draw_56', 'draw_57', 'draw_58', 'draw_59', 'draw_60', 'draw_61', 'draw_62', 'draw_63', 'draw_64', 'draw_65', 'draw_66', 'draw_67', 'draw_68', 'draw_69', 'draw_70', 'draw_71', 'draw_72', 'draw_73', 'draw_74', 'draw_75', 'draw_76', 'draw_77', 'draw_78', 'draw_79', 'draw_80', 'draw_81', 'draw_82', 'draw_83', 'draw_84', 'draw_85', 'draw_86', 'draw_87', 'draw_88', 'draw_89', 'draw_90', 'draw_91', 'draw_92', 'draw_93', 'draw_94', 'draw_95', 'draw_96', 'draw_97', 'draw_98', 'draw_99', 'draw_100', 'draw_101', 'draw_102', 'draw_103', 'draw_104', 'draw_105', 'draw_106', 'draw_107', 'draw_108', 'draw_109', 'draw_110', 'draw_111', 'draw_112', 'draw_113', 'draw_114', 'draw_115', 'draw_116', 'draw_117', 'draw_118', 'draw_119', 'draw_120', 'draw_121', 'draw_122', 'draw_123', 'draw_124', 'draw_125', 'draw_126', 'draw_127', 'draw_128', 'draw_129', 'draw_130', 'draw_131', 'draw_132', 'draw_133', 'draw_134', 'draw_135', 'draw_136', 'draw_137', 'draw_138', 'draw_139', 'draw_140', 'draw_141', 'draw_142', 'draw_143', 'draw_144', 'draw_145', 'draw_146', 'draw_147', 'draw_148', 'draw_149', 'draw_150', 'draw_151', 'draw_152', 'draw_153', 'draw_154', 'draw_155', 'draw_156', 'draw_157', 'draw_158', 'draw_159', 'draw_160', 'draw_161', 'draw_162', 'draw_163', 'draw_164', 'draw_165', 'draw_166', 'draw_167', 'draw_168', 'draw_169', 'draw_170', 'draw_171', 'draw_172', 'draw_173', 'draw_174', 'draw_175', 'draw_176', 'draw_177', 'draw_178', 'draw_179', 'draw_180', 'draw_181', 'draw_182', 'draw_183', 'draw_184', 'draw_185', 'draw_186', 'draw_187', 'draw_188', 'draw_189', 'draw_190', 'draw_191', 'draw_192', 'draw_193', 'draw_194', 'draw_195', 'draw_196', 'draw_197', 'draw_198', 'draw_199', 'draw_200', 'draw_201', 'draw_202', 'draw_203', 'draw_204', 'draw_205', 'draw_206', 'draw_207', 'draw_208', 'draw_209', 'draw_210', 'draw_211', 'draw_212', 'draw_213', 'draw_214', 'draw_215', 'draw_216', 'draw_217', 'draw_218', 'draw_219', 'draw_220', 'draw_221', 'draw_222', 'draw_223', 'draw_224', 'draw_225', 'draw_226', 'draw_227', 'draw_228', 'draw_229', 'draw_230', 'draw_231', 'draw_232', 'draw_233', 'draw_234', 'draw_235', 'draw_236', 'draw_237', 'draw_238', 'draw_239', 'draw_240', 'draw_241', 'draw_242', 'draw_243', 'draw_244', 'draw_245', 'draw_246', 'draw_247', 'draw_248', 'draw_249', 'draw_250', 'draw_251', 'draw_252', 'draw_253', 'draw_254', 'draw_255', 'draw_256', 'draw_257', 'draw_258', 'draw_259', 'draw_260', 'draw_261', 'draw_262', 'draw_263', 'draw_264', 'draw_265', 'draw_266', 'draw_267', 'draw_268', 'draw_269', 'draw_270', 'draw_271', 'draw_272', 'draw_273', 'draw_274', 'draw_275', 'draw_276', 'draw_277', 'draw_278', 'draw_279', 'draw_280', 'draw_281', 'draw_282', 'draw_283', 'draw_284', 'draw_285', 'draw_286', 'draw_287', 'draw_288', 'draw_289', 'draw_290', 'draw_291', 'draw_292', 'draw_293', 'draw_294', 'draw_295', 'draw_296', 'draw_297', 'draw_298', 'draw_299', 'draw_300', 'draw_301', 'draw_302', 'draw_303', 'draw_304', 'draw_305', 'draw_306', 'draw_307', 'draw_308', 'draw_309', 'draw_310', 'draw_311', 'draw_312', 'draw_313', 'draw_314', 'draw_315', 'draw_316', 'draw_317', 'draw_318', 'draw_319', 'draw_320', 'draw_321', 'draw_322', 'draw_323', 'draw_324', 'draw_325', 'draw_326', 'draw_327', 'draw_328', 'draw_329', 'draw_330', 'draw_331', 'draw_332', 'draw_333', 'draw_334', 'draw_335', 'draw_336', 'draw_337', 'draw_338', 'draw_339', 'draw_340', 'draw_341', 'draw_342', 'draw_343', 'draw_344', 'draw_345', 'draw_346', 'draw_347', 'draw_348', 'draw_349', 'draw_350', 'draw_351', 'draw_352', 'draw_353', 'draw_354', 'draw_355', 'draw_356', 'draw_357', 'draw_358', 'draw_359', 'draw_360', 'draw_361', 'draw_362', 'draw_363', 'draw_364', 'draw_365', 'draw_366', 'draw_367', 'draw_368', 'draw_369', 'draw_370', 'draw_371', 'draw_372', 'draw_373', 'draw_374', 'draw_375', 'draw_376', 'draw_377', 'draw_378', 'draw_379', 'draw_380', 'draw_381', 'draw_382', 'draw_383', 'draw_384', 'draw_385', 'draw_386', 'draw_387', 'draw_388', 'draw_389', 'draw_390', 'draw_391', 'draw_392', 'draw_393', 'draw_394', 'draw_395', 'draw_396', 'draw_397', 'draw_398', 'draw_399', 'draw_400', 'draw_401', 'draw_402', 'draw_403', 'draw_404', 'draw_405', 'draw_406', 'draw_407', 'draw_408', 'draw_409', 'draw_410', 'draw_411', 'draw_412', 'draw_413', 'draw_414', 'draw_415', 'draw_416', 'draw_417', 'draw_418', 'draw_419', 'draw_420', 'draw_421', 'draw_422', 'draw_423', 'draw_424', 'draw_425', 'draw_426', 'draw_427', 'draw_428', 'draw_429', 'draw_430', 'draw_431', 'draw_432', 'draw_433', 'draw_434', 'draw_435', 'draw_436', 'draw_437', 'draw_438', 'draw_439', 'draw_440', 'draw_441', 'draw_442', 'draw_443', 'draw_444', 'draw_445', 'draw_446', 'draw_447', 'draw_448', 'draw_449', 'draw_450', 'draw_451', 'draw_452', 'draw_453', 'draw_454', 'draw_455', 'draw_456', 'draw_457', 'draw_458', 'draw_459', 'draw_460', 'draw_461', 'draw_462', 'draw_463', 'draw_464', 'draw_465', 'draw_466', 'draw_467', 'draw_468', 'draw_469', 'draw_470', 'draw_471', 'draw_472', 'draw_473', 'draw_474', 'draw_475', 'draw_476', 'draw_477', 'draw_478', 'draw_479', 'draw_480', 'draw_481', 'draw_482', 'draw_483', 'draw_484', 'draw_485', 'draw_486', 'draw_487', 'draw_488', 'draw_489', 'draw_490', 'draw_491', 'draw_492', 'draw_493', 'draw_494', 'draw_495', 'draw_496', 'draw_497', 'draw_498', 'draw_499', 'draw_500', 'draw_501', 'draw_502', 'draw_503', 'draw_504', 'draw_505', 'draw_506', 'draw_507', 'draw_508', 'draw_509', 'draw_510', 'draw_511', 'draw_512', 'draw_513', 'draw_514', 'draw_515', 'draw_516', 'draw_517', 'draw_518', 'draw_519', 'draw_520', 'draw_521', 'draw_522', 'draw_523', 'draw_524', 'draw_525', 'draw_526', 'draw_527', 'draw_528', 'draw_529', 'draw_530', 'draw_531', 'draw_532', 'draw_533', 'draw_534', 'draw_535', 'draw_536', 'draw_537', 'draw_538', 'draw_539', 'draw_540', 'draw_541', 'draw_542', 'draw_543', 'draw_544', 'draw_545', 'draw_546', 'draw_547', 'draw_548', 'draw_549', 'draw_550', 'draw_551', 'draw_552', 'draw_553', 'draw_554', 'draw_555', 'draw_556', 'draw_557', 'draw_558', 'draw_559', 'draw_560', 'draw_561', 'draw_562', 'draw_563', 'draw_564', 'draw_565', 'draw_566', 'draw_567', 'draw_568', 'draw_569', 'draw_570', 'draw_571', 'draw_572', 'draw_573', 'draw_574', 'draw_575', 'draw_576', 'draw_577', 'draw_578', 'draw_579', 'draw_580', 'draw_581', 'draw_582', 'draw_583', 'draw_584', 'draw_585', 'draw_586', 'draw_587', 'draw_588', 'draw_589', 'draw_590', 'draw_591', 'draw_592', 'draw_593', 'draw_594', 'draw_595', 'draw_596', 'draw_597', 'draw_598', 'draw_599', 'draw_600', 'draw_601', 'draw_602', 'draw_603', 'draw_604', 'draw_605', 'draw_606', 'draw_607', 'draw_608', 'draw_609', 'draw_610', 'draw_611', 'draw_612', 'draw_613', 'draw_614', 'draw_615', 'draw_616', 'draw_617', 'draw_618', 'draw_619', 'draw_620', 'draw_621', 'draw_622', 'draw_623', 'draw_624', 'draw_625', 'draw_626', 'draw_627', 'draw_628', 'draw_629', 'draw_630', 'draw_631', 'draw_632', 'draw_633', 'draw_634', 'draw_635', 'draw_636', 'draw_637', 'draw_638', 'draw_639', 'draw_640', 'draw_641', 'draw_642', 'draw_643', 'draw_644', 'draw_645', 'draw_646', 'draw_647', 'draw_648', 'draw_649', 'draw_650', 'draw_651', 'draw_652', 'draw_653', 'draw_654', 'draw_655', 'draw_656', 'draw_657', 'draw_658', 'draw_659', 'draw_660', 'draw_661', 'draw_662', 'draw_663', 'draw_664', 'draw_665', 'draw_666', 'draw_667', 'draw_668', 'draw_669', 'draw_670', 'draw_671', 'draw_672', 'draw_673', 'draw_674', 'draw_675', 'draw_676', 'draw_677', 'draw_678', 'draw_679', 'draw_680', 'draw_681', 'draw_682', 'draw_683', 'draw_684', 'draw_685', 'draw_686', 'draw_687', 'draw_688', 'draw_689', 'draw_690', 'draw_691', 'draw_692', 'draw_693', 'draw_694', 'draw_695', 'draw_696', 'draw_697', 'draw_698', 'draw_699', 'draw_700', 'draw_701', 'draw_702', 'draw_703', 'draw_704', 'draw_705', 'draw_706', 'draw_707', 'draw_708', 'draw_709', 'draw_710', 'draw_711', 'draw_712', 'draw_713', 'draw_714', 'draw_715', 'draw_716', 'draw_717', 'draw_718', 'draw_719', 'draw_720', 'draw_721', 'draw_722', 'draw_723', 'draw_724', 'draw_725', 'draw_726', 'draw_727', 'draw_728', 'draw_729', 'draw_730', 'draw_731', 'draw_732', 'draw_733', 'draw_734', 'draw_735', 'draw_736', 'draw_737', 'draw_738', 'draw_739', 'draw_740', 'draw_741', 'draw_742', 'draw_743', 'draw_744', 'draw_745', 'draw_746', 'draw_747', 'draw_748', 'draw_749', 'draw_750', 'draw_751', 'draw_752', 'draw_753', 'draw_754', 'draw_755', 'draw_756', 'draw_757', 'draw_758', 'draw_759', 'draw_760', 'draw_761', 'draw_762', 'draw_763', 'draw_764', 'draw_765', 'draw_766', 'draw_767', 'draw_768', 'draw_769', 'draw_770', 'draw_771', 'draw_772', 'draw_773', 'draw_774', 'draw_775', 'draw_776', 'draw_777', 'draw_778', 'draw_779', 'draw_780', 'draw_781', 'draw_782', 'draw_783', 'draw_784', 'draw_785', 'draw_786', 'draw_787', 'draw_788', 'draw_789', 'draw_790', 'draw_791', 'draw_792', 'draw_793', 'draw_794', 'draw_795', 'draw_796', 'draw_797', 'draw_798', 'draw_799', 'draw_800', 'draw_801', 'draw_802', 'draw_803', 'draw_804', 'draw_805', 'draw_806', 'draw_807', 'draw_808', 'draw_809', 'draw_810', 'draw_811', 'draw_812', 'draw_813', 'draw_814', 'draw_815', 'draw_816', 'draw_817', 'draw_818', 'draw_819', 'draw_820', 'draw_821', 'draw_822', 'draw_823', 'draw_824', 'draw_825', 'draw_826', 'draw_827', 'draw_828', 'draw_829', 'draw_830', 'draw_831', 'draw_832', 'draw_833', 'draw_834', 'draw_835', 'draw_836', 'draw_837', 'draw_838', 'draw_839', 'draw_840', 'draw_841', 'draw_842', 'draw_843', 'draw_844', 'draw_845', 'draw_846', 'draw_847', 'draw_848', 'draw_849', 'draw_850', 'draw_851', 'draw_852', 'draw_853', 'draw_854', 'draw_855', 'draw_856', 'draw_857', 'draw_858', 'draw_859', 'draw_860', 'draw_861', 'draw_862', 'draw_863', 'draw_864', 'draw_865', 'draw_866', 'draw_867', 'draw_868', 'draw_869', 'draw_870', 'draw_871', 'draw_872', 'draw_873', 'draw_874', 'draw_875', 'draw_876', 'draw_877', 'draw_878', 'draw_879', 'draw_880', 'draw_881', 'draw_882', 'draw_883', 'draw_884', 'draw_885', 'draw_886', 'draw_887', 'draw_888', 'draw_889', 'draw_890', 'draw_891', 'draw_892', 'draw_893', 'draw_894', 'draw_895', 'draw_896', 'draw_897', 'draw_898', 'draw_899', 'draw_900', 'draw_901', 'draw_902', 'draw_903', 'draw_904', 'draw_905', 'draw_906', 'draw_907', 'draw_908', 'draw_909', 'draw_910', 'draw_911', 'draw_912', 'draw_913', 'draw_914', 'draw_915', 'draw_916', 'draw_917', 'draw_918', 'draw_919', 'draw_920', 'draw_921', 'draw_922', 'draw_923', 'draw_924', 'draw_925', 'draw_926', 'draw_927', 'draw_928', 'draw_929', 'draw_930', 'draw_931', 'draw_932', 'draw_933', 'draw_934', 'draw_935', 'draw_936', 'draw_937', 'draw_938', 'draw_939', 'draw_940', 'draw_941', 'draw_942', 'draw_943', 'draw_944', 'draw_945', 'draw_946', 'draw_947', 'draw_948', 'draw_949', 'draw_950', 'draw_951', 'draw_952', 'draw_953', 'draw_954', 'draw_955', 'draw_956', 'draw_957', 'draw_958', 'draw_959', 'draw_960', 'draw_961', 'draw_962', 'draw_963', 'draw_964', 'draw_965', 'draw_966', 'draw_967', 'draw_968', 'draw_969', 'draw_970', 'draw_971', 'draw_972', 'draw_973', 'draw_974', 'draw_975', 'draw_976', 'draw_977', 'draw_978', 'draw_979', 'draw_980', 'draw_981', 'draw_982', 'draw_983', 'draw_984', 'draw_985', 'draw_986', 'draw_987', 'draw_988', 'draw_989', 'draw_990', 'draw_991', 'draw_992', 'draw_993', 'draw_994', 'draw_995', 'draw_996', 'draw_997', 'draw_998', 'draw_999'])[source]
Parameters:
Return type:

DataFrame

vivarium_inputs.utilities.wide_to_long(data, value_cols, var_name)[source]
Parameters:
Return type:

DataFrame

vivarium_inputs.utilities.sort_hierarchical_data(data)[source]

Reorder index labels of a hierarchical index and sort in level order.

Parameters:

data (DataFrame) –

Return type:

DataFrame

vivarium_inputs.utilities.convert_affected_entity(data, column)[source]
Parameters:
Return type:

DataFrame

vivarium_inputs.utilities.compute_categorical_paf(rr_data, e, affected_entity)[source]
Parameters:
Return type:

DataFrame

vivarium_inputs.utilities.get_age_group_ids_by_restriction(entity, which_age)[source]
Parameters:
Return type:

Tuple[float, float]

vivarium_inputs.utilities.filter_data_by_restrictions(data, entity, which_age, age_group_ids)[source]

For the given data and restrictions, it applies age/sex restrictions and filter out the data outside of the range. Age restrictions can be applied in 4 different ways: - yld - yll - narrowest(inner) range of yll and yld - broadest(outer) range of yll and yld.

Parameters:
  • data (DataFrame) – DataFrame containing ‘age_group_id’ and ‘sex_id’ columns.

  • entity (RiskFactor | Cause) – Cause or RiskFactor

  • which_age (str) – one of 4 choices: ‘yll’, ‘yld’, ‘inner’, ‘outer’.

  • age_group_ids (List[int]) – List of possible age group ids.

Returns:

DataFrame which is filtered out any data outside of age/sex restriction ranges.

Return type:

pandas.DataFrame

vivarium_inputs.utilities.clear_disability_weight_outside_restrictions(data, cause, fill_value, age_group_ids)[source]

Because sequela disability weight is not age/sex specific, we need to have a custom function to set the values outside the corresponding cause restrictions to 0 after it has been expanded over age/sex.

Parameters:
Return type:

DataFrame

vivarium_inputs.utilities.filter_to_most_detailed_causes(data)[source]

For the DataFrame including the cause_ids, it filters rows with cause_ids for the most detailed causes

Parameters:

data (DataFrame) –

Return type:

DataFrame

vivarium_inputs.utilities.get_restriction_age_ids(start_id, end_id, age_group_ids)[source]

Get the start/end age group id and return the list of GBD age_group_ids in-between.

Parameters:
  • start_id (int | None) –

  • end_id (int | None) –

  • age_group_ids (List[int]) –

Return type:

List[int]

vivarium_inputs.utilities.get_restriction_age_boundary(entity, boundary, reverse=False)[source]

Find the minimum/maximum age restriction (if both ‘yll’ and ‘yld’ restrictions exist) for a RiskFactor.

Parameters:
  • entity (RiskFactor | Cause) – RiskFactor or Cause for which to find the minimum/maximum age restriction.

  • boundary (str) – String ‘start’ or ‘end’ indicating whether to return the minimum(maximum) start age restriction or maximum(minimum) end age restriction.

  • reverse – if reverse is True, return the maximum of start age restriction and minimum of end age restriction.

Returns:

  • The age group id corresponding to the minimum or maximum start or end

  • age restriction, depending on boundary, if both ‘yll’ and ‘yld’

  • restrictions exist. Otherwise, returns whichever restriction exists.

vivarium_inputs.utilities.get_exposure_and_restriction_ages(exposure, entity)[source]

Get the intersection of age groups found in exposure data and entity restriction age range. Used to filter other risk data where using just exposure age groups isn’t sufficient because exposure at the point of extraction is pre-filtering by age restrictions.

Parameters:
  • exposure (DataFrame) – Exposure data for entity.

  • entity (RiskFactor) – Entity for which to find the intersecting exposure and restriction ages.

Returns:

  • Set of age groups found in both the entity’s exposure data and in the

  • entity’s age restrictions.

Return type:

set

vivarium_inputs.utilities.split_interval(data, interval_column, split_column_prefix)[source]