Auxiliary for controlling segmented model fitting
Auxiliary function as user interface for 'segmented' fitting. Typically
only used when calling any 'segmented' method (segmented.lm
, segmented.glm
, segmented.Arima
or segmented.default
).
seg.control(n.boot=10, display = FALSE, tol = 1e-05, it.max = 30, fix.npsi=TRUE, K = 10, quant = TRUE, maxit.glm = 25, h = 1, break.boot=5, size.boot=NULL, jt=FALSE, nonParam=TRUE, random=TRUE, seed=12345, fn.obj=NULL, digits=NULL, conv.psi=FALSE, alpha=.02, min.step=.0001, powers=c(1,1), last = TRUE, stop.if.error = NULL, gap=FALSE, fc=.95)
n.boot |
number of bootstrap samples used in the bootstrap restarting algorithm. If 0 the standard algorithm,
i.e. without bootstrap restart, is used. Default to 10 that appears to be sufficient in most of problems. However
when multiple breakpoints have to be estimated it is suggested to increase |
display |
logical indicating if the value of the objective function should be printed (along with current breakpoint estimates) at each iteration or at each bootstrap resample. If bootstrap restarting is employed, the values of objective and breakpoint estimates should not change at the last runs. |
tol |
positive convergence tolerance. |
it.max |
integer giving the maximal number of iterations. |
fix.npsi |
logical (it replaces previous argument |
K |
the number of quantiles (or equally-spaced values) to supply as starting values for the breakpoints
when the |
quant |
logical, indicating how the starting values should be selected. If |
maxit.glm |
integer giving the maximum number of inner IWLS iterations (see details). |
h |
positive factor modifying the increments in breakpoint updates during the estimation process (see details). |
break.boot |
Integer, less than |
size.boot |
the size of the bootstrap samples. If |
jt |
logical. If |
nonParam |
if |
random |
if |
seed |
The seed to be passed on to |
fn.obj |
A character string to be used (optionally) only when |
digits |
optional. If specified it means the desidered number of decimal points of the breakpoint to be used during the iterative algorithm. |
conv.psi |
optional. Should convergence of iterative procedure to be assessed on changes of breakpoint estimates or changes in the objective? Default to FALSE. |
alpha |
optional numerical value. The breakpoint is estimated within the quantiles |
min.step |
optional. The minimum step size to break the iterative algorithm. Default to 0.0001. |
powers |
The powers of the pseudo covariates employed by the algorithm. These can be altered during the iterative process to stabilize the estimation procedure. Usually of no interest for the user. This argument will be removed in next releases. |
last |
logical indicating if output should include only the last fitted model. This argument will be removed in next releases |
stop.if.error |
same than |
gap |
logical, if |
fc |
A proportionality factor (<= 1) to adjust the breakpoint estimates if these come close to the boundary or too close each other. For instance, if |
Fitting a ‘segmented’ GLM model is attained via fitting iteratively standard GLMs. The number of (outer)
iterations is governed by it.max
, while the (maximum) number of (inner) iterations to fit the GLM at
each fixed value of psi is fixed via maxit.glm
. Usually three-four inner iterations may be sufficient.
When the starting value for the breakpoints is set to NA
for any segmented variable specified
in seg.Z
, K
values (quantiles or equally-spaced) are selected as starting values for the breakpoints.
In this case, it may be useful to set also fix.npsi=FALSE
to automate the procedure, see Muggeo and Adelfio (2011).
The maximum number of iterations (it.max
) should be also increased when the ‘automatic’ procedure is used.
If last=TRUE
, the object resulting from segmented.lm
(or segmented.glm
) is a
list of fitted GLM; the i-th model is the segmented model with the values of the breakpoints at the i-th iteration.
Since version 0.2-9.0 segmented
implements the bootstrap restarting algorithm described in Wood (2001).
The bootstrap restarting is expected to escape the local optima of the objective function when the
segmented relationship is flat. Notice bootstrap restart runs n.boot
iterations regardless of
tol
that only affects convergence within the inner loop.
A list with the arguments as components.
Vito Muggeo
Muggeo, V.M.R., Adelfio, G. (2011) Efficient change point detection in genomic sequences of continuous measurements. Bioinformatics 27, 161–166.
Wood, S. N. (2001) Minimizing model fitting objectives that contain spurious local minima by bootstrap restarting. Biometrics 57, 240–244.
#decrease the maximum number inner iterations and display the #evolution of the (outer) iterations #seg.control(display = TRUE, maxit.glm=4)
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.