mcparam.clip.tails: Filter a Monte Carlo distribution by quantiles

View source: R/mcpar-analysis.R

mcparam.clip.tailsR Documentation

Filter a Monte Carlo distribution by quantiles

Description

This filters on all parameter simultaneously, so any sample that is outside the requested quantile range in the marginal distribution of any parameter will be excluded.

Usage

mcparam.clip.tails(mc.data, qlo = 0.01, qhi = 0.99)

Arguments

mc.data

Data frame of Monte Carlo output

qlo

Lower quantile for filtering

qhi

Upper quantile for filtering.

Details

The log-posterior column is handled a bit differently; it isn't filtered on the high end, just the low end.

The purpose of this function was to trim values far out on the tails that made the plot scales impossible to read.

Value

Logical vector with TRUE for rows that are in the main body of the distribution, FAlSE for those that aren't.


JGCRI/ambrosia documentation built on June 11, 2025, 12:29 a.m.