updating documentation

4 files changed, 21 insertions, 6 deletions

diff --git a/R/estpoly.R b/R/estpoly.R
index 0e7cc2c..661306e 100644
--- a/R/estpoly.R
+++ b/R/estpoly.R
@@ -197,9 +197,11 @@ arx <- function(x,order=c(0,1,0),lambda=0.1){
 #' Fit an ARMAX model of the specified order given the input-output data 
 #' 
 #' @param x an object of class \code{idframe}
-#' @param order: Specification of the orders: the four integer components 
+#' @param order Specification of the orders: the four integer components 
 #' (na,nb,nc,nk) are the order of polynolnomial A, order of polynomial B 
 #' + 1, order of the polynomial C,and the input-output delay respectively
+#' @param init_sys Linear polynomial model that configures the initial parameterization.
+#' Must be an ARMAX model. Overrules the \code{order} argument
 #' @param options Estimation Options, setup using \code{\link{optimOptions}}
 #' 
 #' @details
@@ -297,6 +299,8 @@ armax <- function(x,order=c(0,1,1,0),init_sys=NULL,options=optimOptions()){
 #' @param order Specification of the orders: the four integer components 
 #' (nb,nf,nk) are order of polynomial B + 1, order of the polynomial F,
 #' and the input-output delay respectively
+#' @param init_sys Linear polynomial model that configures the initial parameterization.
+#' Must be an OE model. Overrules the \code{order} argument
 #' @param options Estimation Options, setup using 
 #' \code{\link{optimOptions}}
 #' 
@@ -397,6 +401,8 @@ oe <- function(x,order=c(1,1,0),init_sys=NULL,options=optimOptions()){
 #' (nb,nc,nd,nf,nk) are order of polynomial B + 1, order of the polynomial C,
 #' order of the polynomial D, order of the polynomial F, and the 
 #' input-output delay respectively
+#' @param init_sys Linear polynomial model that configures the initial parameterization.
+#' Must be a BJ model. Overrules the \code{order} argument
 #' @param options Estimation Options, setup using 
 #' \code{\link{optimOptions}}
 #' 
diff --git a/man/armax.Rd b/man/armax.Rd
index b9939d8..5bb880a 100644
--- a/man/armax.Rd
+++ b/man/armax.Rd
@@ -4,16 +4,19 @@
 \alias{armax}
 \title{Estimate ARMAX Models}
 \usage{
-armax(x, order = c(0, 1, 1, 0), options = optimOptions())
+armax(x, order = c(0, 1, 1, 0), init_sys = NULL, options = optimOptions())
 }
 \arguments{
 \item{x}{an object of class \code{idframe}}
 
-\item{options}{Estimation Options, setup using \code{\link{optimOptions}}}
-
-\item{order:}{Specification of the orders: the four integer components 
+\item{order}{Specification of the orders: the four integer components 
 (na,nb,nc,nk) are the order of polynolnomial A, order of polynomial B 
 + 1, order of the polynomial C,and the input-output delay respectively}
+
+\item{init_sys}{Linear polynomial model that configures the initial parameterization.
+Must be an ARMAX model. Overrules the \code{order} argument}
+
+\item{options}{Estimation Options, setup using \code{\link{optimOptions}}}
 }
 \value{
 An object of class \code{estpoly} containing the following elements:
diff --git a/man/bj.Rd b/man/bj.Rd
index 30d2702..563a761 100644
--- a/man/bj.Rd
+++ b/man/bj.Rd
@@ -14,6 +14,9 @@ bj(z, order = c(1, 1, 1, 1, 0), init_sys = NULL, options = optimOptions())
 order of the polynomial D, order of the polynomial F, and the 
 input-output delay respectively}
 
+\item{init_sys}{Linear polynomial model that configures the initial parameterization.
+Must be a BJ model. Overrules the \code{order} argument}
+
 \item{options}{Estimation Options, setup using 
 \code{\link{optimOptions}}}
 }
diff --git a/man/oe.Rd b/man/oe.Rd
index 7d0427e..86239d2 100644
--- a/man/oe.Rd
+++ b/man/oe.Rd
@@ -4,7 +4,7 @@
 \alias{oe}
 \title{Estimate Output-Error Models}
 \usage{
-oe(x, order = c(1, 1, 0), options = optimOptions())
+oe(x, order = c(1, 1, 0), init_sys = NULL, options = optimOptions())
 }
 \arguments{
 \item{x}{an object of class \code{idframe}}
@@ -13,6 +13,9 @@ oe(x, order = c(1, 1, 0), options = optimOptions())
 (nb,nf,nk) are order of polynomial B + 1, order of the polynomial F,
 and the input-output delay respectively}
 
+\item{init_sys}{Linear polynomial model that configures the initial parameterization.
+Must be an OE model. Overrules the \code{order} argument}
+
 \item{options}{Estimation Options, setup using 
 \code{\link{optimOptions}}}
 }