modes: Mode Extractor
In copre: Tools for Nonparametric Martingale Posterior Sampling

modes

R Documentation

Mode Extractor

Description

Extracts the modes from a copre_result or seqre_result object.

Usage

modes(obj, mean = FALSE, grd = NULL, idx = FALSE, anti = FALSE)

## S3 method for class 'seqre_result'
modes(obj, mean = FALSE, grd = NULL, idx = FALSE, anti = FALSE)

## S3 method for class 'grideval_result'
modes(obj, mean = FALSE, grd = NULL, idx = FALSE, anti = FALSE)

n_modes(obj, mean = FALSE, grd = NULL, anti = FALSE)

Arguments

`obj`	A `copre_result` or `seqre_result` object.
`mean`	A logical value indicating whether to count the modes of the mean density of each of the individual sampled density.
`grd`	For `seqre_result`, a grid on which to evaluate the object.
`idx`	A logical value indicating whether to also return the index within `grd` of the discovered modes.
`anti`	A logical value indicating whether to extract true modes or anti-modes (i.e. local minima of the density function).