get_times: Get distribution of time-metrics

Description Usage Arguments Details Examples

Description

For diagnostic purposes, the user may wish to explore metrics such as the distribution of the incubation period (transition between exposed and infected), or recovery time, or time-to-failure/fatality and compare this to the real world estimates. For example, it is known that the COVID19 incubation period is anywhere between 5 and 14 days.

Usage

1
get_times(net_build_object)

Arguments

net_build_object

object returned by net_simulate

Details

The network_simulation object contain several time features for each individual, namely, the time to exposure, the time to infection, etc. This function is used to calculate common metric that may be chosen to be evaluated. It is mostly for internal usage.

Copied from Tim Churches' blogpost.

For more info on tidy evaluation check https://dplyr.tidyverse.org/articles/programming.html#eliminating-r-cmd-check-notes (i.e. why there is so much .data in this function source)

Examples

1
times_df = get_times(net_example)

AIforGoodSimulator/network-model-R-package documentation built on Oct. 3, 2020, 10:08 a.m.