nsims.nlists: Number of Simulations

Description Usage Arguments Value See Also Examples

View source: R/nsims.R

Description

Gets the number of simulations (iterations * chains) of an MCMC object.

The default methods returns the product of nchains() and niters().

Usage

1
2
## S3 method for class 'nlists'
nsims(x, ...)

Arguments

x

An object.

...

Other arguments passed to methods.

Value

An integer scalar of the number of simulations.

See Also

Other MCMC dimensions: nchains(), niters(), npars(), nsams(), nterms()

Examples

1
2
nsims(nlists(nlist(x = c(2, 9)), nlist(x = c(1, 7))))
nsims(split_chains(nlists(nlist(x = c(2, 9)), nlist(x = c(1, 7)))))

Example output

[1] 2
[1] 2

nlist documentation built on Sept. 5, 2021, 6:05 p.m.