ssm_summary: Quickly summarize the state-space model posteriors

Description Usage Arguments

View source: R/3b_ssm_summary.R

Description

Quickly summarize the state-space model posteriors

Usage

1
2
ssm_summary(post, params, model, diag_plots = F, file = NULL,
  seed = NA, plot_dir = NULL, return_post = F)

Arguments

post

an object of class mcmc.list

params

a list object created by SimFit::init_sim() or kusko_data_prep()$params. Contains the driving parameters and dimensional variables.

model

the model identifier: e.g., a number or letter

diag_plots

logical. Do you wish to save traceplots and density plots for convergence diagnostics? Defaults to FALSE.

file

character vector of length 1: optional file name of the saved diagnostic plots.

seed

a numeric vector of length 1: represents a secondary identifier. Typically would be used to identify the seed. To exclude, set to the default: NA.

plot_dir

character vector representing the directory or full path to the location where you wish to save the plot files, if diag_plots = TRUE. Defaults to NULL, which will place the files in the working directory.

return_post

logical. Do you wish to return a list with elements equal to $ests (the standard estimate summary) and $post (the updated mcmc.list object)? Defaults to FALSE.


bstaton1/FitSR documentation built on Aug. 23, 2019, 11:13 a.m.