bistablehistory (version 1.1.2)

history_parameter: Extract values of used or fitted history parameter

Description

Extract values of used or fitted history parameter

Usage

history_parameter(
  object,
  param,
  summary = TRUE,
  probs = c(0.055, 0.945),
  includePopulationLevel = TRUE
)

Value

A vector, if summary was not requested. Or a tibble with a summary or if a fixed value was used.

Arguments

object

An object of class cumhist

param

Parameter name: "tau" or "mixed_state"

summary

Whether summary statistics should be returned instead of raw sample values. Defaults to TRUE

probs

The percentiles used to compute summary, defaults to 89% credible interval.

includePopulationLevel

Logical, for pooled random effect only. Whether to include population mean as a separate "_population" level, default to TRUE.

Examples

# \donttest{
br_fit <- fit_cumhist(br_singleblock, state="State", duration="Duration")
history_parameter(br_fit, "tau")
# }