diff options
| author | Suraj Yerramilli | 2016-05-17 10:45:59 +0530 |
|---|---|---|
| committer | Suraj Yerramilli | 2016-05-17 10:45:59 +0530 |
| commit | 25ffd8e93cd9da5bb79800bfb112d9bab14944b6 (patch) | |
| tree | cd5c01b5f2572db0d75793d5ef8f979a33cf4085 | |
| parent | f5ee56f5bd764944374f46fcb8ad74b582bff2d9 (diff) | |
| download | SysID-R-code-25ffd8e93cd9da5bb79800bfb112d9bab14944b6.tar.gz SysID-R-code-25ffd8e93cd9da5bb79800bfb112d9bab14944b6.tar.bz2 SysID-R-code-25ffd8e93cd9da5bb79800bfb112d9bab14944b6.zip | |
adding documentation for estpoly
| -rw-r--r-- | R/estpoly.R | 20 | ||||
| -rw-r--r-- | man/estpoly.Rd | 37 |
2 files changed, 57 insertions, 0 deletions
diff --git a/R/estpoly.R b/R/estpoly.R index a2bf7de..46b2ff7 100644 --- a/R/estpoly.R +++ b/R/estpoly.R @@ -1,3 +1,23 @@ +#' Estimated polynomial object +#' +#' Estimated discrete-time polynomial model returned from an estimation +#' routine. +#' +#' @param sys an \code{idpoly} object containing the estimated polynomial +#' coefficients +#' @param fitted.values 1-step ahead predictions on the training dataset +#' @param residuals 1-step ahead prediction errors +#' @param options optimization specification ser used (applicable for non-linear least +#' squares) +#' @param call the matched call +#' @param stats a list containing estimation statistics +#' @param termination termination criteria for optimization +#' @param input input signal of the training data-set +#' +#' @details +#' Do not use \code{estpoly} for directly specifing an input-output polynomial model. +#' \code{\link{idpoly}} is to be used instead +#' #' @export estpoly <- function(sys,fitted.values,residuals,options=NULL, call,stats,termination=NULL,input){ diff --git a/man/estpoly.Rd b/man/estpoly.Rd new file mode 100644 index 0000000..13a5556 --- /dev/null +++ b/man/estpoly.Rd @@ -0,0 +1,37 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/estpoly.R +\name{estpoly} +\alias{estpoly} +\title{Estimated polynomial object} +\usage{ +estpoly(sys, fitted.values, residuals, options = NULL, call, stats, + termination = NULL, input) +} +\arguments{ +\item{sys}{an \code{idpoly} object containing the estimated polynomial +coefficients} + +\item{fitted.values}{1-step ahead predictions on the training dataset} + +\item{residuals}{1-step ahead prediction errors} + +\item{options}{optimization specification ser used (applicable for non-linear least +squares)} + +\item{call}{the matched call} + +\item{stats}{a list containing estimation statistics} + +\item{termination}{termination criteria for optimization} + +\item{input}{input signal of the training data-set} +} +\description{ +Estimated discrete-time polynomial model returned from an estimation +routine. +} +\details{ +Do not use \code{estpoly} for directly specifing an input-output polynomial model. +\code{\link{idpoly}} is to be used instead +} + |