watch_stan: Watch the progress of a Stan session

Description Usage Arguments Value

View source: R/watch_stan.R

Description

Watch the progress of a Stan session

Usage

1
2
3
4
5
6
7
8
watch_stan(
  update_interval = 1,
  one_line_per_chain = TRUE,
  spacing = 2,
  beep_when_done = TRUE,
  kill_on_divergence = FALSE,
  timeout = NA
)

Arguments

update_interval

Number of seconds to wait between updates.

one_line_per_chain

A logical value specifying whether the progress for each chain should be printed on seperate lines.

spacing

An integer value specifying the number of extra spaces to add to the end of each chain's progress string. Can be used to fix misalignment when one_line_per_chain is TRUE.

beep_when_done

A logical value specifying whether a sound should be played on completion (requires the beepr package to be installed).

kill_on_divergence

A logical value specifying whether to kill chains if a post-warmup divergence is encountered.

timeout

A numeric value indicating the number of seconds after which the sampling is automatically terminated if not complete. If NA (the default), no timeout is enforced.

Value

No value is returned.


mike-lawrence/ezStan documentation built on Dec. 29, 2021, 1:30 a.m.