Description Usage Arguments Value Author(s) References See Also Examples
View source: R/makeChangePointModel.R
This function is used to create a change point model (CPM) S4 object. The CPM object can be used to process a sequence of data, one observation at a time. The CPM object maintains its state between each observation, and can be queried to obtain the D_{k,t}
statistics, and to test whether a change has been detected.
Note that this function is part of the S4 object section of the cpm
package, which allows for more precise control over the change detection process. For many simple change detection applications this extra complexity will not be required, and the detectChangePoint
and processStream
functions should be used instead.
For a fuller overview of this function including a description of the CPM framework and examples of how to use the various functions, please consult the package manual "Parametric and Nonparametric Sequential Change Detection in R: The cpm Package" available from www.gordonjross.co.uk
1 2 | makeChangePointModel(cpmType, ARL0=500, startup=20, lambda=NA)
|
cpmType |
The type of CPM which is to be created. Possible arguments are:
|
ARL0 |
Determines the ARL_0 which the CPM should have, which corresponds to the average number of observations before a false positive occurs, assuming that the sequence does not undergo a chang. Because the thresholds of the CPM are computationally expensive to estimate, the package contains pre-computed values of the thresholds corresponding to several common values of the ARL_0. This means that only certain values for the ARL_0 are allowed. Specifically, the ARL_0 must have one of the following values: 370, 500, 600, 700, ..., 1000, 2000, 3000, ..., 10000, 20000, ..., 50000. |
startup |
The number of observations after which monitoring begins. No change points will be flagged during this startup period. This must be set to at least 20. |
lambda |
A smoothing parameter which is used to reduce the discreteness of the test statistic when using the FET CPM. See [Ross and Adams, 2012b] in the References section for more details on how this parameter is used. Currently the package only contains sequences of ARL0 thresholds corresponding to lambda=0.1 and lambda=0.3, so using other values will result in an error. If no value is specified, the default value will be 0.1. |
A CPM S4 object. The class of this object will depend on the value which has been passed as the cpmType
argument.
Gordon J. Ross gordon@gordonjross.co.uk
Hawkins, D. , Zamba, K. (2005) – A Change-Point Model for a Shift in Variance, Journal of Quality Technology, 37, 21-31
Hawkins, D. , Zamba, K. (2005b) – Statistical Process Control for Shifts in Mean or Variance Using a Changepoint Formulation, Technometrics, 47(2), 164-173
Hawkins, D., Qiu, P., Kang, C. (2003) – The Changepoint Model for Statistical Process Control, Journal of Quality Technology, 35, 355-366.
Ross, G. J., Tasoulis, D. K., Adams, N. M. (2011) – A Nonparametric Change-Point Model for Streaming Data, Technometrics, 53(4)
Ross, G. J., Adams, N. M. (2012) – Two Nonparametric Control Charts for Detecting Arbitary Distribution Changes, Journal of Quality Technology, 44:102-116
Ross, G. J., Adams, N. M. (2013) – Sequential Monitoring of a Proportion, Computational Statistics, 28(2)
Ross, G. J., (2014) – Sequential Change Detection in the Presence of Unknown Parameters, Statistics and Computing 24:1017-1030
Ross, G. J., (2015) – Parametric and Nonparametric Sequential Change Detection in R: The cpm Package, Journal of Statistical Software, forthcoming
processObservation, changeDetected, cpmReset
.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | #generate a sequence containing a single change point
x <- c(rnorm(100,0,1),rnorm(100,1,1))
#use a Student CPM
cpm <- makeChangePointModel(cpmType="Student", ARL0=500)
for (i in 1:length(x)) {
#process each observation in turn
cpm <- processObservation(cpm,x[i])
if (changeDetected(cpm)) {
print(sprintf("change detected at observation %s",i))
break
}
}
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.