birth_cohort_simulation: birth_cohort_simulation

In laurettemhlanga/PopulationSimulation: Population Simulation

birth_cohort_simulation

Description

A wrapper function that returns a list of the the susceptible and infected population

Usage

birth_cohort_simulation(
  date_of_birth,
  time_step,
  max_age,
  time_slice,
  birth_rate,
  pmtct_birth_rate,
  base_mortality_function,
  incidence_function,
  excess_mortality_function,
  detailed = FALSE
)

Arguments

date_of_birth	the minimum date of birth for the birth cohorts
time_step	the time step between consecurtive dates or the length of the time between date of births of cohorts
max_age	maximum age attained by each birth cohort
time_slice	dates for conducting surveys
birth_rate	the birth rate in the hypothetical population at the specified times
pmtct_birth_rate	the birth rate newborns who are infecteds.
base_mortality_function	a function that specifies the rate of occurence of natural deaths with arguments age and time.
incidence_function	a function that specifies the rate of occurence of the infections with arguments age and time.
excess_mortality_function	a function that specifies the rate of occurence ofdisease induced deaths with arguments age and time.
detailed	allows for a switch in the function

Value

a matrix of column length max_age and row length list_of_birth_times, Values stored in the matrix are numeric double, from 0-1, which represent the probability of becoming infected at age and time

laurettemhlanga/PopulationSimulation documentation built on Sept. 9, 2023, 12:39 p.m.