From def2e790cff46159f20f3163c90d71b3301ca89d Mon Sep 17 00:00:00 2001 From: Suraj Yerramilli Date: Sat, 2 Jan 2016 15:39:45 +0530 Subject: modified the doc format --- man/armax.Rd | 34 +++++++++++++++------------------- man/arx.Rd | 24 ++++++++++-------------- man/oe.Rd | 34 +++++++++++++++------------------- 3 files changed, 40 insertions(+), 52 deletions(-) (limited to 'man') diff --git a/man/armax.Rd b/man/armax.Rd index 56f358c..b1ca54d 100644 --- a/man/armax.Rd +++ b/man/armax.Rd @@ -17,26 +17,22 @@ armax(x, order = c(0, 1, 1, 0), options = optimOptions()) } \value{ An object of class \code{estpoly} containing the following elements: - -\tabular{ll}{ - \code{sys} \tab an \code{idpoly} object containing the - fitted ARMAX coefficients \cr - \code{fitted.values} \tab the predicted response \cr - \code{residuals} \tab the residuals \cr - \code{input} \tab the input data used \cr - \code{call} \tab the matched call \cr - \code{stats} \tab A list containing the following fields: - \code{vcov} - the covariance matrix of the fitted coefficients, - \code{sigma} - the standard deviation of the innovations \cr - \code{options} \tab Option set used for estimation. If no - custom options were configured, this is a set of default options. \cr - \code{termination} \tab Termination conditions for the iterative + \item{sys}{an \code{idpoly} object containing the + fitted ARMAX coefficients} + \item{fitted.values}{the predicted response} + \item{residuals}{the residuals} + \item{input}{the input data used} + \item{call}{the matched call} + \item{stats}{A list containing the following fields: \cr + \code{vcov} - the covariance matrix of the fitted coefficients \cr + \code{sigma} - the standard deviation of the innovations} + \item{options}{Option set used for estimation. If no + custom options were configured, this is a set of default options} + \item{termination}{Termination conditions for the iterative search used for prediction error minimization: - \code{WhyStop} - Reason for termination, - \code{iter} - Number of Iterations, - \code{iter} - Number of Function Evaluations - - } + \code{WhyStop} - Reason for termination \cr + \code{iter} - Number of Iterations \cr + \code{iter} - Number of Function Evaluations } } \description{ Fit an ARMAX model of the specified order given the input-output data diff --git a/man/arx.Rd b/man/arx.Rd index afba710..f2a2cc2 100644 --- a/man/arx.Rd +++ b/man/arx.Rd @@ -15,20 +15,16 @@ the input-output delay} } \value{ An object of class \code{estpoly} containing the following elements: - -\tabular{ll}{ - \code{sys} \tab an \code{idpoly} object containing the - fitted ARX coefficients \cr - \code{fitted.values} \tab the predicted response \cr - \code{residuals} \tab the residuals \cr - \code{input} \tab the input data used \cr - \code{call} \tab the matched call \cr - \code{stats} \tab A list containing the following fields: - \code{vcov} - the covariance matrix of the fitted coefficients, - \code{sigma} - the standard deviation of the innovations, - \code{df} -the residual degrees of freedom - - } + \item{sys}{an \code{idpoly} object containing the + fitted ARX coefficients} + \item{fitted.values}{the predicted response} + \item{residuals}{the residuals} + \item{input}{the input data used} + \item{call}{the matched call} + \item{stats}{A list containing the following fields: \cr + \code{vcov} - the covariance matrix of the fitted coefficients \cr + \code{sigma} - the standard deviation of the innovations\cr + \code{df} - the residual degrees of freedom} } \description{ Fit an ARX model of the specified order given the input-output data diff --git a/man/oe.Rd b/man/oe.Rd index b556109..04141f4 100644 --- a/man/oe.Rd +++ b/man/oe.Rd @@ -18,26 +18,22 @@ and the input-output delay respectively} } \value{ An object of class \code{estpoly} containing the following elements: - -\tabular{ll}{ - \code{sys} \tab an \code{idpoly} object containing the - fitted OE coefficients \cr - \code{fitted.values} \tab the predicted response \cr - \code{residuals} \tab the residuals \cr - \code{input} \tab the input data used \cr - \code{call} \tab the matched call \cr - \code{stats} \tab A list containing the following fields: - \code{vcov} - the covariance matrix of the fitted coefficients, - \code{sigma} - the standard deviation of the innovations \cr - \code{options} \tab Option set used for estimation. If no - custom options were configured, this is a set of default options. \cr - \code{termination} \tab Termination conditions for the iterative + \item{sys}{an \code{idpoly} object containing the + fitted OE coefficients} + \item{fitted.values}{the predicted response} + \item{residuals}{the residuals} + \item{input}{the input data used} + \item{call}{the matched call} + \item{stats}{A list containing the following fields: \cr + \code{vcov} - the covariance matrix of the fitted coefficients \cr + \code{sigma} - the standard deviation of the innovations} + \item{options}{Option set used for estimation. If no + custom options were configured, this is a set of default options} + \item{termination}{Termination conditions for the iterative search used for prediction error minimization: - \code{WhyStop} - Reason for termination, - \code{iter} - Number of Iterations, - \code{iter} - Number of Function Evaluations - - } + \code{WhyStop} - Reason for termination \cr + \code{iter} - Number of Iterations \cr + \code{iter} - Number of Function Evaluations } } \description{ Fit an output-error model of the specified order given the input-output data -- cgit