bistablehistory (version 1.1.2)

history_tau: Extract values of used or fitted history parameter tau

Description

A short-cut for history_parameter(object, "tau", ...).

Usage

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

Value

A single value, if fixed value was used. A vector or a tibble, depending on the option used (single intercept, independent or random intercepts), and whether summary was requested.

Arguments

object

An object of class cumhist

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_tau(br_fit)
# }