stan_filter: Return post-warmup samples with matching conditions

In metrumresearchgroup/shredder: Rstan Manipulation API

Description

Use stan_filter() to choose indicies of samples across parameters where conditions are true.

Usage

stan_filter(object, ..., permuted = TRUE)

Arguments

object	stanfit object
...	Logical predicates defined in terms of the parameters in object
permuted	A logical scalar indicating whether the draws after the warmup period in each chain should be permuted and merged, Default: TRUE

Details

• If no elements are returned for any chain then NULL is returned with a warning.

• If there is a chain that results in no samples then the chain is dropped with a warning.

• If permuted is FALSE then uneven chains may be returned depending on the result of the filter.

• To comply with extract with permuted=TRUE chains in which chaines are assumed to be of equal size.

  • Chain size returned is the length of the shortest filtered chain.

Value

stanfit object

See Also

Other filtering: stan_slice(), stan_thin_n()

Examples

rats <- rats_example(nCores = 1)

rats%>%
  stan_select(mu_alpha,mu_beta)
  
rats%>%
  stan_select(mu_alpha,mu_beta)%>%
  stan_filter(mu_beta < 6)
  
rats%>%
  stan_select(mu_alpha,mu_beta)%>%
  stan_filter(mu_beta < 6, permuted = FALSE)
  
rats%>%
 stan_select(`alpha[1]`,`alpha[2]`,mu_alpha,mu_beta)%>%
 stan_filter(mu_beta < 6 & `alpha[1]` > 240)

metrumresearchgroup/shredder documentation built on Sept. 1, 2020, 5:36 p.m.