Man pages for mrc-ide/safir
Individual-Based Model of COVID Transmission

allocate_treatmentAllocate treatment
assign_dosesAssign doses to eligible persons based on available supply...
attach_event_listenersAttach listeners to events
attach_event_listeners_independent_natAttach event listeners for modeling independent...
attach_event_listeners_natural_immunityAttach event listeners for natural immunity events
attach_event_listeners_nimueAttach listeners to events (nimue vaccine model)
attach_event_listeners_vaccinationAttach event listeners for vaccination events (multi-dose, no...
attach_hosp_listenersAttach listeners to track hospitalization and ICU incidence
attach_tracking_listener_age_incidenceAttach listener to track age-stratified incidence
attach_tracking_listener_incidenceAttach listener to track incidence
categorical_count_renderer_process_dailyRender categories every day
compartments_age_render_process_dailyRender categories by age every day
create_age_incidence_tracking_listenerCreate listener to track age-stratified incidence
create_age_variablesCreate age variables
create_continuous_age_variableContinuous age variable
create_discrete_age_variableDiscrete age variable
create_eventsCreate events
create_event_scheduler_listenerA listener to schedule future events
create_events_nimueAppend vaccination events (nimue vaccine model)
create_events_vaccinationAppend vaccination events
create_exposure_scheduler_listener_nimueModelling the progression to either IMild, ICase, IAsymp...
create_exposure_scheduler_listener_vaccineModelling the progression to either IMild, ICase, IAsymp...
create_hospital_scheduler_listenerCreate listener function to schedule events upon...
create_hospital_scheduler_listener_cppCreate C++ listener function to schedule events upon...
create_hospital_scheduler_listener_cpp_internalInternal C++ function factory for scheduling events upon...
create_hosp_renderersCreate list of renderer objects to track hospitalization and...
create_incidence_tracking_listenerCreate listener to track incidence
create_independent_nat_variablesCreate independent infection-derived NAT variables
create_natural_immunity_variablesCreate natural immunity variables
create_state_update_listenerA listener to update state
create_state_variablesDefine model states
create_v0_to_v1v2_listener_nimueCreate listener for initial vaccination (nimue vaccine model)
create_v1v2_to_v3v4_listener_nimueCreate listener for start of vaccine protection (nimue...
create_v3v4_to_v5_listener_nimueCreate listener for decay of vaccine protection (nimue...
create_vaccination_dose_listenerCreate listener for vaccination dose (multi-dose, no types)
create_vaccine_variablesCreate vaccination variables (multi-dose, no types)
create_vaccine_variables_nimueCreate vaccination variables (nimue vaccine model)
create_variablesCreate age & state variables
cross_tab_compartments_ageCross tabulate compartments and age
cross_tab_doses_ageCross tabulate doses and age
cross_tab_marginsCross tabulate two vectors with given margins
dose_age_render_process_dailyRender doses by age every day
get_asymptomaticFunction to add asymptomatic information
get_contact_matrix_cppGet contact matrix
get_current_coverageGet people who either have this dose or are scheduled for it
get_current_eligible_from_coverageGet persons who are eligible for this dose
get_parametersGet parameters from squire model
get_parameters_nimueGet parameters for safir (nimue vaccine model)
get_populationGet population from SQUIRE model
get_proportion_vaccinated_nimueGet proportion of an age group that is vaccinated (nimue...
get_state_vectorGet vector of states from parameters
get_time_since_last_doseCalculate the time elapsed in days since each person's last...
get_time_since_last_dose_or_infectionCalculate the time elapsed in days since each person's last...
get_time_since_last_infectionCalculate the time elapsed in days since each person's last...
get_vaccination_priority_stageGet prioritisation step for a specific dosing phase
get_vaccine_ab_titre_parametersGet vaccine efficacy and Ab titre parameters
get_vector_cppGet a value from a vector
identify_ages_to_adjustIdentify ages to adjust
independent_ab_titre_processUpdate NAT for seperate vaccine and infection-derived NAT
infection_processInfection process (squire transmission model)
infection_process_cppC++ infection process (squire transmission model)
infection_process_cpp_internalC++ infection process (squire transmission model)
infection_process_nimueInfection process (nimue vaccine model)
infection_process_nimue_cppC++ infection process (nimue vaccine model)
infection_process_nimue_cpp_internalC++ infection process (nimue vaccine model)
infection_process_vaccineInfection process for vaccine model (multi-dose, no types)
infection_process_vaccine_cppC++ infection process for vaccine model (multi-dose, no...
infection_process_vaccine_cpp_internalC++ infection process for vaccine model (multi-dose, no...
initialize_vaccine_variablesInitialize vaccination variables (multi-dose, no types)
integer_count_render_processRender integer variables
integer_count_render_process_dailyRender integer variables every day
interp_input_parInterpolate input parameters
interpolate_rtProduce piecewise linear Rt
iso3c_agesMedian ages for countries
make_calculate_natMake function to calculate population NAT
make_immune_parametersAttach parameters dealing with immune (NAT) dynamics to...
make_independent_vaccine_infection_nat_parametersAttach parameters for modeling seperate vaccine and infection...
make_rerlangMake Erlang waiting time distribution
make_rexpMake discretized exponential waiting time distribution
make_vaccine_parametersCombine and verify vaccine parameters
matrix_2vec_mult_cppMultiply a matrix by a integer vector and a double vector
matrix_vec_mult_cppMultiply a matrix by a integer vector
mult_2matrix_rowsumElement-wise multiply two matrices and take row sums
natural_immunity_ab_titre_processProcess that updates the antibody (Ab) titre each time step...
process_hosp_renderersProcess rendering output of hospitalization and ICU incidence
safirsafir: squire and friends individual rewrite
schedule_dose_vaccineSchedule some individuals for a vaccination dose
schedule_outcomeSchedule outcome
setup_eventsSchedule events for individuals at initialisation
setup_events_nimueSchedule events for individuals at initialisation (nimue...
simulation_loop_safirSimulation loop for safir models
swap_agesSwap values that have been identified
tab_binsTabulate a vector of observations
tab_bins_weightedTabulate a weighted vector of observations
target_popTarget persons in each age group to vaccinate (multi-dose, no...
update_vaccine_variablesUpdate vaccine variables
vaccination_processVaccination distribution process (multiple doses, no types)
vaccination_process_nimueVaccination process (nimue vaccine model)
vaccination_process_nimue_cppC++ vaccination process (nimue vaccine model)
vaccination_process_nimue_cpp_internalC++ infection process (nimue vaccine model)
vaccine_ab_titre_processProcess that updates the antibody (Ab) titre each time step
vaccine_efficacy_infectionCompute vaccine efficacy against infection from Ab titre
vaccine_efficacy_infection_cppCompute vaccine efficacy against infection from Ab titre...
vaccine_efficacy_severeCompute vaccine efficacy against severe disease from Ab titre
vaccine_efficacy_severe_cppCompute vaccine efficacy against severe disease from Ab titre...
vaccine_efficacy_transmissionCompute vaccine efficacy against onward transmission from Ab...
vaccine_efficacy_transmission_cppCompute vaccine efficacy against onward transmission from Ab...
variant_fold_reduction_vectorMake vector of variant fold reduction in natural antibody...
mrc-ide/safir documentation built on Aug. 2, 2022, 10:47 a.m.