stsmFit: Interface to Different Fitting Procedures

Description Usage Arguments Details Value See Also


This function is an interface to the methods available in the package for fitting a structural time series model (maximum likelihood in the time and frequency domain via different optimization algorithms).


stsmFit(x, stsm.method = c("maxlik.fd.scoring", "", 
  "maxlik.fd.optim", ""), xreg = NULL, ...)



an object of class stsm.


a character indicating the method to be used.


further arguments to be passed to the the function selected in stsm.method.


vector or matrix of external regresors.


This interface is useful to simplify the code and reduce the number of arguments in functions that call some of those functions that can be specified through stsm.method. For example, the package tsoutliers uses:"stsmFit", args = c(list(x = y, args.tsmethod)), where args.tsmethod is a list containing the arguments to be passed to stsmFit, which includes stsm.method. Thus, the code is simplified since no switch or if statements are necessary; the number of arguments is also reduced since those that are passed tot the function specified in stsm.method are gathered in a list.

The external regressors can be defined in the input object x of class stsm. This is the way the recommend specification for functions and maxlik.fd. This interface allows defining xreg as an argument passed to this function because it simplifies the code in some functions of package tsoutliers. If xreg and x@xreg are both not NULL and error is returned.


A list of class stsmFit. See the section ‘Value’ in maxlik.fd.

See Also

maxlik.fd.scoring,, maxlik.fd.optim and

Search within the stsm package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.