subset: Subset an MCMC object

Description Usage Arguments Methods (by class) See Also Examples

Description

Subsets an MCMC object by its chains, iterations and/or parameters.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
## S3 method for class 'mcmcarray'
subset(x, chains = NULL, iters = NULL, iterations = NULL, ...)

## S3 method for class 'mcmcr'
subset(
  x,
  chains = NULL,
  iters = NULL,
  pars = NULL,
  iterations = NULL,
  parameters = NULL,
  ...
)

## S3 method for class 'mcmcrs'
subset(
  x,
  chains = NULL,
  iters = NULL,
  pars = NULL,
  iterations = NULL,
  parameters = NULL,
  ...
)

Arguments

x

The MCMC object to subset

chains

An integer vector of chains.

iters

An integer vector of iterations.

iterations

An integer vector (or NULL) of the iterations to subset by.

...

Unused.

pars

A character vector of parameter names.

parameters

A character vector (or NULL) of the parameters to subset by.

Methods (by class)

See Also

universals::split_chains()

Examples

1
2
3
4
subset(mcmcr_example,
  chains = 2L, iters = 1:100,
  pars = c("beta", "alpha")
)

Example output

$beta
          [,1]     [,2]
[1,] 0.7591235 1.759124
[2,] 1.7591235 2.759124

nchains:  1 
niters:  100 

$alpha
[1] 3.044835 4.044835

nchains:  1 
niters:  100 

mcmcr documentation built on Sept. 7, 2021, 1:07 a.m.