Function reference
Main functions
Run the ITHIM model - the setting up the environments (variables and loading files), running the model and generating the outputs.
- 
          
          
run_ithim() - Wrapper for running ITHIM
 
- 
          
          
run_ithim_setup() - Run the set up scripts for ITHIM
 
- 
          
          
add_distance_columns() - Add strike and casualty distances to injury tables
 
- 
          
          
add_ghost_trips() - Addition of ghost trips
 
- 
          
          
add_motorcycle_trips_Chile() - Personal motorcycle trips for Chilean cities
 
- 
          
          
add_trips() - Additional trips for trip data set
 
- 
          
          
add_walk_trips() - Addition of 'walk to public transport' stages to trip set
 
- 
          
          
AP_dose_response() - Calculate relative risk given PM exposure level
 
- 
          
          
ap_dose_response_curve() - Computes RR as a DR relationship - CURRENTLY NOT USED
 
- 
          
          
assign_age_groups() - Assign age groups to individuals
 
- 
          
          
beta_pointiness() - Parameterise confidence in PA data - CURRENTLY NOT IN USE
 
- 
          
          
combined_rr_ap_pa() - Combine relative risks from air pollution and physical activity
 
- 
          
          
combine_health_and_pif() - Combine health and potential impact fraction (PIF)
 
- 
          
          
complete_trip_distance_duration() - Add missing trip information
 
- 
          
          
create_bogota_scenarios() - Create scenarios for Bogota
 
- 
          
          
create_global_scenarios() - Create global scenarios
 
- 
          
          
create_base_pop() - Creates baseline population
 
- 
          
          
dirichlet_pointiness() - Function for Dirichlet parameters
 
- 
          
          
distances_for_injury_function() - Get distances and parameterise Poisson regression model for injuries
 
- 
          
          
dist_dur_tbls() - Get distances and duration summaries by mode
 
- 
          
          
extract_data_for_voi() - Get ITHIM-results into correct format for VoI analysis
 
- 
          
          
gen_ap_rr() - Get relative risk for diseases given PM exposure
 
- 
          
          
gen_pa_rr() - Get relative risk for diseases given mMETs
 
- 
          
          
get_all_distances() - Find population distances by mode for entire population
 
- 
          
          
get_scenario_settings() - Get values for mode share across distance categories and for max mode share scenario - CURRENTLY only used when calling summary_tables.Rmd
 
- 
          
          
get_synthetic_from_trips() - Generate baseline population from trip data
 
- 
          
          
health_burden() - Compute health burden
 
- 
          
          
injuries_function_2() - Predict injuries
 
- 
          
          
injury_death_to_yll() - Map injury death burden to YLL (years of life lost) burden
 
- 
          
          
ithim_calculation_sequence() - Cascade of computations that form ITHIM-Global
 
- 
          
          
ithim_load_data() - Load data for model and prepare input data for model
 
- 
          
          
ithim_setup_baseline_scenario() - Set up baseline scenario data frame
 
- 
          
          
ithim_setup_parameters() - Set parameters for ITHIM-Global run
 
- 
          
          
ithim_uncertainty() - Sampling routine for running ITHIM with uncertainty
 
- 
          
          
join_hb_and_injury() - Join disease health burden and injury data
 
- 
          
          
scale_trip_distances() - Scale trip distances
 
- 
          
          
scenario_co2_calculations() - Calculate total CO2 exposure per mode and scenario
 
- 
          
          
scenario_pm_calculations() - Calculate total AP exposure per person
 
- 
          
          
set_injury_contingency() - Injury summary statistics
 
- 
          
          
set_scenario_specific_variables() - Set scenario specific variables - CURRENTLY NOT CALLED
 
- 
          
          
set_vehicle_inventory() - Collate all vehicle information
 
- 
          
          
total_mmet() - Calculate total mMETs per person
 
- 
          
          
walk_to_pt_and_combine_scen() - Add walk to public transport stages