createLineList: Convert simulation output to line list

Description Usage Arguments Details Value

View source: R/llFunction.R

Description

convertLineList takes simulation output on cases, converts numeric time to dates, and adds an observation layer to output observed cases on a specified date.

Usage

1
2
3
4
5
6
7
8
createLineList(
  cases,
  obs_prob,
  mean_report_delay,
  mean_confirm_delay,
  zero_date,
  obs_date = as.character(Sys.Date())
)

Arguments

cases

A data frame generated by simpleSim with rows representing all cases that occur in the outbreak simulation, having at minimum the following columns: id (unique individual ID),

obs_prob

The individual-level probabilty that a case is reported (numeric)

mean_report_delay

The average number of days between disease onset and reporting to a health facility (numeric)

mean_confirm_delay

The average number of days between reporting to a health facility and confirmation of a case (numeric)

zero_date

Character string representing the date on which the initial case was infected (YYYY-MM-DD)

obs_date

Character string representing the date on which observation of the state of the line list takes place (YYYY-MM-DD; default = system date)

Details

TODO: Add more details later

Value

Returns a data frame the provides the line list, as observed on obs_date

TODO: Add more detail


jrcpulliam/LLsim documentation built on Feb. 5, 2020, 8:49 p.m.