summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSuraj Yerramilli2016-02-17 11:28:44 +0530
committerSuraj Yerramilli2016-02-17 11:28:44 +0530
commit92c3caebef9ae7bb361d6811589d3fd6e5c0430a (patch)
tree4947c12d78bee54dcbcc7ceca91aa399eab00703
parentd6508786ce6c12c92e9a061c07d50c04bc39dec5 (diff)
downloadSysID-R-code-92c3caebef9ae7bb361d6811589d3fd6e5c0430a.tar.gz
SysID-R-code-92c3caebef9ae7bb361d6811589d3fd6e5c0430a.tar.bz2
SysID-R-code-92c3caebef9ae7bb361d6811589d3fd6e5c0430a.zip
correcting documentation
-rw-r--r--R/estpoly.R15
-rw-r--r--man/armax.Rd2
-rw-r--r--man/arx.Rd5
-rw-r--r--man/bj.Rd2
-rw-r--r--man/oe.Rd2
5 files changed, 12 insertions, 14 deletions
diff --git a/R/estpoly.R b/R/estpoly.R
index 7d85408..8e72f76 100644
--- a/R/estpoly.R
+++ b/R/estpoly.R
@@ -126,9 +126,8 @@ residplot <- function(model,newdata=NULL){
#' \ldots + b_{nk+nb} u[k-nk-nb] + e[k]
#' }
#' The function estimates the coefficients using linear least squares (with
-#' no regularization). Future versions may include regularization
-#' parameters as well
-#' \\
+#' regularization).
+#' \cr
#' The data is expected to have no offsets or trends. They can be removed
#' using the \code{\link{detrend}} function.
#'
@@ -212,7 +211,7 @@ arx <- function(x,order=c(0,1,0),lambda=0.1){
#' }
#' The function estimates the coefficients using non-linear least squares
#' (Levenberg-Marquardt Algorithm)
-#' \\
+#' \cr
#' The data is expected to have no offsets or trends. They can be removed
#' using the \code{\link{detrend}} function.
#'
@@ -300,7 +299,7 @@ armax <- function(x,order=c(0,1,1,0),options=optimOptions()){
#' }
#' The function estimates the coefficients using non-linear least squares
#' (Levenberg-Marquardt Algorithm)
-#' \\
+#' \cr
#' The data is expected to have no offsets or trends. They can be removed
#' using the \code{\link{detrend}} function.
#'
@@ -404,7 +403,7 @@ oe <- function(x,order=c(1,1,0),options=optimOptions()){
#'
#' The function estimates the coefficients using non-linear least squares
#' (Levenberg-Marquardt Algorithm)
-#' \\
+#' \cr
#' The data is expected to have no offsets or trends. They can be removed
#' using the \code{\link{detrend}} function.
#'
@@ -440,8 +439,8 @@ oe <- function(x,order=c(1,1,0),options=optimOptions()){
#' residplot(mod_bj) # residual plots
#'
#' @export
-bj <- function(z,order=c(1,1,1,1,0),init_sys=NULL,
- options=optimOptions()){
+bj <- function(z,order=c(1,1,1,1,0),
+ init_sys=NULL,options=optimOptions()){
y <- outputData(z); u <- inputData(z); N <- dim(y)[1]
nb <- order[1];nc <- order[2]; nd <- order[3];
nf <- order[4]; nk <- order[5];
diff --git a/man/armax.Rd b/man/armax.Rd
index b1ca54d..b9939d8 100644
--- a/man/armax.Rd
+++ b/man/armax.Rd
@@ -46,7 +46,7 @@ SISO ARMAX models are of the form
}
The function estimates the coefficients using non-linear least squares
(Levenberg-Marquardt Algorithm)
-\\
+\cr
The data is expected to have no offsets or trends. They can be removed
using the \code{\link{detrend}} function.
}
diff --git a/man/arx.Rd b/man/arx.Rd
index 0479bf0..5dcc4e5 100644
--- a/man/arx.Rd
+++ b/man/arx.Rd
@@ -36,9 +36,8 @@ SISO ARX models are of the form
\ldots + b_{nk+nb} u[k-nk-nb] + e[k]
}
The function estimates the coefficients using linear least squares (with
-no regularization). Future versions may include regularization
-parameters as well
-\\
+regularization).
+\cr
The data is expected to have no offsets or trends. They can be removed
using the \code{\link{detrend}} function.
}
diff --git a/man/bj.Rd b/man/bj.Rd
index 453789e..30d2702 100644
--- a/man/bj.Rd
+++ b/man/bj.Rd
@@ -63,7 +63,7 @@ The orders of Box-Jenkins model are defined as follows:
The function estimates the coefficients using non-linear least squares
(Levenberg-Marquardt Algorithm)
-\\
+\cr
The data is expected to have no offsets or trends. They can be removed
using the \code{\link{detrend}} function.
}
diff --git a/man/oe.Rd b/man/oe.Rd
index 04141f4..7d0427e 100644
--- a/man/oe.Rd
+++ b/man/oe.Rd
@@ -47,7 +47,7 @@ SISO OE models are of the form
}
The function estimates the coefficients using non-linear least squares
(Levenberg-Marquardt Algorithm)
-\\
+\cr
The data is expected to have no offsets or trends. They can be removed
using the \code{\link{detrend}} function.
}