summaryHostSwitch: Summary statistics of HostSwitch simulation

Description Usage Arguments Details Value Examples

View source: R/HostSwitch.R

Description

Summary statistics of HostSwitch simulation

Usage

1
summaryHostSwitch(HostSwitch_simulated_quantities, warmup = 1)

Arguments

HostSwitch_simulated_quantities

An object created by simHostSwitch

warmup

warmup is the number of initial generations to be excluded from summary statistics, see details. Possible value are NULL or positive integer (min=1, max=50), default value = 1

Details

This function generates summary statistics for HostSwitch simulations. Quantities of interest for each simulation are averaged. If n_sim = 1, these averages for this single simulation are shown. If n_sim > 1, summary statistics are applied on the simulation averages.

Warmup represents the initial condition for the simulation, the users may defined it as an adaptation stage of the simulation model. If warmup = 1 the generation at time 0 is excluded from summary, if warmup = 2 the generations at times 0 and 1 are excluded and so on. If warmup = NULL all generations are considered for summary statistics.

Value

Summary of HostSwitch simulations

Examples

1
2
3
4
## Create an object HostSwitch with 100 simulations and default values for all the other parameters
m1 = simHostSwitch(n_sim=100)

summaryHostSwitch(m1)

HostSwitch documentation built on Sept. 27, 2021, 9:06 a.m.