summary_sir: OUTPUT FUNCTION

View source: R/run_SIR.R

summary_sirR Documentation

OUTPUT FUNCTION

Description

Function that provides a summary of SIR outputs including: mean, median, 95 credible interval, 90

Usage

summary_sir(x, object = "USERDEFINED", file_name = "NULL")

Arguments

x

A data.frame of mcmc samples.

object

Name of the model object as specified by the user.

file_name

name of a file to identified the files exported by the function. If NULL, will not save .csv file.

Value

Returns a data.frame with summary of SIR outputs

Examples

x  <-  rnorm(1000, 5, 7)
y  <-  rnorm(1000, 6, 9)
df <- data.frame(x = x, y = y)
summary_sir( df , object = "example_summary")

antarctic-humpback-2019-assessment/HumpbackSIR documentation built on Nov. 6, 2023, 6:07 p.m.