nsims.nlist: Number of Simulations

Description Usage Arguments Details 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 'nlist'
nsims(x, ...)

Arguments

x

An object.

...

Other arguments passed to methods.

Details

Always 1L.

Value

An integer scalar of the number of simulations.

See Also

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

Examples

1
nsims(nlist(x = 1:2))

Example output

[1] 1

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