cpt.reg-class | R Documentation |
A class for changepoint objects, specifically change in regression.
Objects can be created by calls of the form new("cpt", ...)
.
new("cpt", ...)
:creates a new object with class cpt
data.set
:Object of class "numeric"
, the original vector of data
cpttype
:Object of class "character"
, the type of changepoint that was identified
method
:Object of class "character"
, the method that was used to search for changepoints, default change in regression
test.stat
:Object of class "character"
, the test statistic used to analyse the data
pen.type
:Object of class "character"
, the penalty type specified in the analysis
pen.value
:Object of class "numeric"
, the value of the penalty used in the analysis
minseglen
:Object of class "numeric"
, the minimum segment length (no. of observations between changepoints) used in the analysis.
cpts
:Object of class "numeric"
, vector of changepoints identified
ncpts.max
:Object of class "numeric"
, maximum number of changepoint that can be identified
param.est
:Object of class "list"
, list where each element is a vector of parameter estimates, if requested
date
:Object of class "character"
, date and time the changepoint analysis was run
version
:Object of class "character"
, version number of the package used when the analysis was run.
signature(object = "cpt.reg")
: retrieves cpts slot
signature(object = "cpt.reg")
: retrieves cpttype slot
signature(object = "cpt.reg")
: retrieves data.set slot
signature(object = "cpt.reg")
: retrieves test.stat slot
signature(object = "cpt.reg")
: retrieves ncpts.max slot
signature(object = "cpt.reg")
: retrieves method slot
signature(object = "cpt")
: retrieves minseglen slot
signature(object = "cpt.reg")
: retrieves param.est slot
signature(object = "cpt.reg")
: retrieves pen.type slot
signature(object = "cpt.reg")
: retrieves pen.value slot
signature(object = "cpt.reg")
: replaces cpts slot
signature(object = "cpt.reg")
: replaces cpttype slot
signature(object = "cpt.reg")
: replaces data.set slot
signature(object = "cpt.reg")
: replaces test.stat slot
signature(object = "cpt.reg")
: replaces ncpts.max slot
signature(object = "cpt.reg")
: replaces method slot
signature(object = "cpt.reg")
: replaces param.est slot
signature(object = "cpt.reg")
: replaces pen.type slot
signature(object = "cpt.reg")
: replaces pen.value slot
signature(object = "cpt.reg")
: prints details of the cpt object including summary
signature(object = "cpt.reg")
: prints a summary of the cpt object
signature(object = "cpt.reg")
: calculates the parameter estimates for the cpt object
Rebecca Killick
plot-methods
,cpts-methods
,cpt
showClass("cpt.reg")
x=new("cpt.reg") # creates a new object with the cpt.reg class defaults
data.set(x) # retrieves the data.set slot from x
data.set(x)<-matrix(1:10,nrow=5,ncol=2) # replaces the data.set slot from x with a matrix
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.