BinSegInfo: Check available algorithms and distributions

Description Usage Value Details See Also

View source: R/UserInterface.R

Description

This function allows to check which algorithms and distributions are implemented in the package. It provides the string that must be passed as a parameter to the BinSeg method, along with a small description.

Usage

1

Value

A List with two slots, one for Algorithms and one for Distributions. Each one of them is a Character Matrix with a column for the parameter string and another one for the description.

Details

This method queries directly the C++ code in order to find which distributions are currently available, as well as the name that must be passed to use them. The benefit is that no R code must be modified when a new Distribution or Algorithm is added. Only by adding on C++ it is possible to register it on the return matrix of this method.

See Also

BinSegModel to perform changepoint analysis.


diego-urgell/BinSeg documentation built on Dec. 19, 2021, 11:11 p.m.