Diff of /man/sampler.stats.Rd [000000] .. [ede2d4]

Switch to unified view

a b/man/sampler.stats.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/summaries.R
3
\name{sampler.stats}
4
\alias{sampler.stats}
5
\title{Sampler statistics}
6
\usage{
7
sampler.stats(object)
8
}
9
\arguments{
10
\item{object}{An object of class \code{hsstan}.}
11
}
12
\value{
13
A matrix with \code{C + 1} rows, where \code{C} is the number of Markov
14
chains, reporting average acceptance probability, average stepsize, number
15
of divergent transitions, maximum tree depth, total number of gradient
16
evaluations, warmup and sampling times in seconds.
17
}
18
\description{
19
Report statistics on the parameters used in the sampler, the sampler
20
behaviour and the sampling time.
21
}
22
\examples{
23
\dontshow{utils::example("hsstan", echo=FALSE)}
24
# continued from ?hsstan
25
sampler.stats(hs.biom)
26
27
}