Description Usage Arguments Details Value Author(s) See Also Examples
View source: R/online.class_input.R
This function helps to input all the necessary information into the correct format for ocpt
and ocpt.range
classes.
This function is called by ocpt.mean.initialise
, ocpt.var.initialise
and ocpt.meanvar.initialise
and all the corresponding update functions. 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!
1 2 3 4 |
sumstat |
Summary statistic used in changepoint analysis, see |
cpttype |
Type of changepoint analysis performed as a text string, e.g. "Mean", "Mean and Variance". |
method |
Method used as a text string, see |
test.stat |
The assumed test statistic / distribution of the data as a text string. , see |
penalty |
Penalty used as a text string, see |
pen.value |
Numerical penalty value used in the analysis (positive). |
minseglen |
Minimum segment length used in the analysis (positive integer). |
param.estimates |
Logical. If TRUE then parameter estimates are calculated. If FALSE no parameter estimates are calculated and the slot is blank in the returned object. |
out |
List of output from |
Q |
The value of |
shape |
Value of the assumed known shape parameter required when test.stat="Gamma". |
lastchangelike |
Vector of lenght n containing the likelihood of the optimal segmentation up to each timepoint. |
lastchangecpts |
Vector of length n containing the last changepoint prior to each timepoint. |
checklist |
Vector of locations of the potential last changepoint for next iteration (to be updated), max length=(ndone+nupdate). |
nchecklist |
Stores the current number of changepoints detected. |
ndone |
Length of the time series when analysis begins. |
nupdate |
Length of the time series to be analysed in this update. |
cost_func |
The cost function that has been used. |
This function takes all the input required for the ocpt
or ocpt.range
classes and enters it into the 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 ocpt
and ocpt.range
classes.
An object of class ocpt
or ocpt.range
as appropriate filled with the given attributes.
Andrew Connell, Rebecca Killick
ocpt.var.initialise
,ocpt.mean.initialise
,ocpt
1 2 | #This function should only be used by developers,
#see its use in ocpt.mean, ocpt.var and ocpt.meanvar.
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.