cpt.geo-class: Class '"cpt.geo"'

In grundy95/changepoint.geo: Geometrically Inspired Multivariate Changepoint Detection

Description

A class for cpt.geo objects.

Objects from the Class

Objects can be created by calls of the form new("cpt.geo", ...).

new('cpt.geo',...):

Creates a new object with class cpt.geo

Slots

data.set:

Object of class "matrix", original data set to be analyzed for changepoints

distance:

Object of class "numeric", distance mapping of each time vector.

angle:

Object of class "numeric", angle mapping of each time vector.

penalty:

Object of class "character", type of penalty used as a text string.

pen.value:

Object of class "numeric", numeric value of penalty used.

test.stat:

Object of class "character", test statistic used for the analysis.

msl:

Object of class "numeric", minimum segment length (no. of observations between changepoints).

nquantiles:

Object of class "numeric", number of quantiles used in the empirical distribution.

dist.cpts:

Object of class "numeric", changepoint locations in the distances.

ang.cpts:

Object of class "numeric", changepoint locations in the angles.

dist.out:

Object of class cpt, contains the output of the PELT analysis of the distance mappings. See cpt.meanvar and documentation within to apply methods from the changepoint package to this object.

ang.out:

Object of class cpt, contains the output of the PELT analysis of the angle mappings. See cpt.meanvar and documentation within to apply methods from the changepoint package to this object.

date:

Object of class "character", date the analysis was run.

version:

Object of class "character", version number of the package when analysis was run.

Methods

ang.cpts

signature(object = "cpt.geo"): retrieves ang.cpts slot.

ang.cpts<-

signature(object = "cpt.geo"): replaces ang.cpts slot.

ang.out

signature(object = "cpt.geo"): retrieves ang.out slot.

ang.out<-

signature(object = "cpt.geo"): replaces ang.out slot.

angle

signature(object = "cpt.geo"): retrieves angle slot.

angle<-

signature(object = "cpt.geo"): replaces angle slot.

data.set

signature(object = "cpt.geo"): retrieves data.set slot.

data.set<-

signature(object = "cpt.geo"): replaces data.set slot.

dist.cpts

signature(object = "cpt.geo"): retrieves dist.cpts slot.

dist.cpts<-

signature(object = "cpt.geo"): replaces dist.cpts slot.

dist.out

signature(object = "cpt.geo"): retrieves dist.out slot.

dist.out<-

signature(object = "cpt.geo"): replaces dist.out slot.

distance

signature(object = "cpt.geo"): retrieves distance slot.

distance<-

signature(object = "cpt.geo"): replaces distance slot.

msl

signature(object = "cpt.geo"): retrieves msl slot.

msl<-

signature(object = "cpt.geo"): replaces msl slot.

nquantiles

signature(object = "cpt.geo"): retrieves nquantiles slot.

nquantiles<-

signature(object = "cpt.geo"): replaces nquantiles slot.

pen.value

signature(object = "cpt.geo"): retrieves pen.value slot.

pen.value<-

signature(object = "cpt.geo"): replaces pen.value slot.

penalty

signature(object = "cpt.geo"): retrieves penalty slot.

penalty<-

signature(object = "cpt.geo"): replaces penalty slot.

plot

signature(object = "cpt.geo"): returns an object from ggplot of the distance and angle mappings.

show

signature(object = "cpt.geo"): prints details of the cpt.geo object including a summary.

summary

signature(object = "cpt.geo"): prints a summary of the cpt.geo object.

test.stat

signature(object = "cpt.geo"): retrieves test.stat slot.

test.stat<-

signature(object = "cpt.geo"): replaces test.stat slot.

Author(s)

Thomas Grundy

See Also

geomcp,plot-methods,ggplot

Examples

showClass("cpt.geo")	#shows the structure of the cpt.geo class.

x=new('cpt.geo')	#creates a new object with the cpt.geo class defaults
dist.cpts(x)		#retrieves the dist.cpts slot from x
dist.cpts(x) <- c(50,100) #replaces the dist.cpts slot from x with c(50,100)

grundy95/changepoint.geo documentation built on March 27, 2021, 6:01 a.m.