class_input {changepoint.geo}R Documentation

Input all required arguments into cpt.geo class - Only intended for developer use.

Description

This function helps to input all necessary information into the correct format for the cpt.geo class.

This function is called when class=TRUE. This is not intended for use by regular users of the package. It is exported for developers to call directly for speed and convenience.

WARNING: No checks on arguments are performed!

Usage

class_input(data.set, distance, angle, penalty, pen.value, test.stat,
	    msl, nquantiles, dist.cpts, ang.cpts)

Arguments

data.set

Data set used in multivariate changepoint analysis, see geomcp for further details.

distance

Vector containing the distance mappings

angle

Vector containing the angle mappings

penalty

Penalty used as a text string, see geomcp for further details.

pen.value

Numerical penalty value used in the univariate analysis of the mapped time series.

test.stat

The assumed test statistic/distribution of the univariate mapped time series as a text string. See geomcp for further details.

msl

Minimum segment length used in the analysis (positive integer).

nquantiles

Number of quantiles used in empirical distribution if using test.stat='Empirical'.

dist.cpts

Changepoint locations in distance mappings.

ang.cpts

Changepoint locations in angle mappings.

Details

This function takes all the input required for the cpt.geo class and enters it into an object.

This function is exported for developer use only. It does not perform any checks on inputs and is simply a convenience function for converting the output of the worker functions into a nice format for the cpt.geo class.

Value

An object of class cpt.geo filled with the given attributes.

Author(s)

Thomas Grundy

See Also

geomcp,plot-methods,cpt.geo

Examples

#This function should only be used by developers, see its use in geomcp.

[Package changepoint.geo version 1.0.1 Index]