adding documentation for datasets

8 files changed, 184 insertions, 0 deletions

diff --git a/man/armaxsim.Rd b/man/armaxsim.Rd
new file mode 100644
index 0000000..69f41f1
--- /dev/null
+++ b/man/armaxsim.Rd
@@ -0,0 +1,24 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.R
+\docType{data}
+\name{armaxsim}
+\alias{armaxsim}
+\title{Data simulated from an ARMAX model}
+\format{an \code{idframe} object with 2555 samples, one input and one
+output}
+\usage{
+armaxsim
+}
+\description{
+This dataset contains 2555 samples simulated from the following ARMAX model:
+\deqn{
+ y[k] = \frac{0.6q^{-2} - 0.2q^{-3}}{1 - 0.5q^{-1}} u[k] + 
+ \frac{1-0.3q^{-1}}{1 - 0.5q^{-1}} e[k]
+}
+}
+\details{
+The model is simulated with a 2555 samples long full-band PRBS input.
+The noise variance is set to 0.1
+}
+\keyword{datasets}
+
diff --git a/man/arxsim.Rd b/man/arxsim.Rd
new file mode 100644
index 0000000..4972ff6
--- /dev/null
+++ b/man/arxsim.Rd
@@ -0,0 +1,24 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.R
+\docType{data}
+\name{arxsim}
+\alias{arxsim}
+\title{Data simulated from an ARX model}
+\format{an \code{idframe} object with 2555 samples, one input and one
+output}
+\usage{
+arxsim
+}
+\description{
+This dataset contains 2555 samples simulated from the following ARX model:
+\deqn{
+ y[k] = \frac{0.6q^{-2} - 0.2q^{-3}}{1 - 0.5q^{-1}} u[k] + 
+ \frac{1}{1 - 0.5q^{-1}} e[k]
+}
+}
+\details{
+The model is simulated with a 2555 samples long full-band PRBS input.
+The noise variance is set to 0.1
+}
+\keyword{datasets}
+
diff --git a/man/bjsim.Rd b/man/bjsim.Rd
new file mode 100644
index 0000000..d599860
--- /dev/null
+++ b/man/bjsim.Rd
@@ -0,0 +1,24 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.R
+\docType{data}
+\name{bjsim}
+\alias{bjsim}
+\title{Data simulated from an BJ model}
+\format{an \code{idframe} object with 2046 samples, one input and one
+output}
+\usage{
+bjsim
+}
+\description{
+This dataset contains 2046 samples simulated from the following BJ model:
+\deqn{
+ y[k] = \frac{0.6q^{-2} - 0.2q^{-3}}{1 - 0.5q^{-1}} u[k] + 
+ \frac{1+0.2q^{-1}}{1 - 0.3q^{-1}} e[k]
+}
+}
+\details{
+The model is simulated with a 2046 samples long full-band PRBS input.
+The noise variance is set to 0.1
+}
+\keyword{datasets}
+
diff --git a/man/cstr.Rd b/man/cstr.Rd
new file mode 100644
index 0000000..7dcc0d1
--- /dev/null
+++ b/man/cstr.Rd
@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.R
+\docType{data}
+\name{cstr}
+\alias{cstr}
+\title{Continuous stirred tank reactor data (idframe)}
+\format{an \code{idframe} object with 7500 samples, one input and two
+outputs}
+\usage{
+cstr
+}
+\description{
+The Process is a model of a Continuous Stirring Tank Reactor, 
+where the reaction is exothermic and the concentration is 
+controlled by regulating the coolant flow.
+\cr
+}
+\details{
+Inputs: q, Coolant Flow l/min
+Outputs:
+\item{Ca}{Concentration mol/l}
+\item{T}{Temperature Kelvin}
+}
+\keyword{datasets}
+
diff --git a/man/cstrData.Rd b/man/cstrData.Rd
new file mode 100644
index 0000000..5a0a6c6
--- /dev/null
+++ b/man/cstrData.Rd
@@ -0,0 +1,28 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.R
+\docType{data}
+\name{cstrData}
+\alias{cstrData}
+\title{Continuous stirred tank reactor data (data.frame)}
+\format{an \code{data.frame} object with 7500 rows and three columns:
+q, Ca and T}
+\source{
+\url{ftp://ftp.esat.kuleuven.ac.be/pub/SISTA/espinosa/datasets/cstr.dat}
+}
+\usage{
+cstrData
+}
+\description{
+The Process is a model of a Continuous Stirring Tank Reactor, 
+where the reaction is exothermic and the concentration is 
+controlled by regulating the coolant flow.
+\cr
+}
+\details{
+Inputs: q, Coolant Flow l/min
+Outputs:
+\item{Ca}{Concentration mol/l}
+\item{T}{Temperature Kelvin}
+}
+\keyword{datasets}
+
diff --git a/man/cstr_mis.Rd b/man/cstr_mis.Rd
new file mode 100644
index 0000000..15f9433
--- /dev/null
+++ b/man/cstr_mis.Rd
@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.R
+\docType{data}
+\name{cstr_mis}
+\alias{cstr_mis}
+\title{Continuous stirred tank reactor data with missing values}
+\format{an \code{idframe} object with 7500 samples, one input and two
+outputs}
+\usage{
+cstr_mis
+}
+\description{
+This dataset is derived from the \code{cstr} dataset with few samples
+containing missing values, in one or all variables. It is used to 
+demonstrate the capabilities of the \code{misdata} routine.
+}
+\seealso{
+\code{\link{cstr}}, \code{\link{misdata}}
+}
+\keyword{datasets}
+
diff --git a/man/frd.Rd b/man/frd.Rd
new file mode 100644
index 0000000..c122fed
--- /dev/null
+++ b/man/frd.Rd
@@ -0,0 +1,15 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.R
+\docType{data}
+\name{frd}
+\alias{frd}
+\title{Frequency response data}
+\format{an \code{idfrd} object with response at 128 frequency points}
+\usage{
+frd
+}
+\description{
+This dataset contains frequency response data of an unknown SISO system.
+}
+\keyword{datasets}
+
diff --git a/man/oesim.Rd b/man/oesim.Rd
new file mode 100644
index 0000000..7ecf0a7
--- /dev/null
+++ b/man/oesim.Rd
@@ -0,0 +1,23 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.R
+\docType{data}
+\name{oesim}
+\alias{oesim}
+\title{Data simulated from an OE model}
+\format{an \code{idframe} object with 2555 samples, one input and one
+output}
+\usage{
+oesim
+}
+\description{
+This dataset contains 2555 samples simulated from the following OE model:
+\deqn{
+ y[k] = \frac{0.6q^{-2} - 0.2q^{-3}}{1 - 0.5q^{-1}} u[k] + e[k]
+}
+}
+\details{
+The model is simulated with a 2555 samples long full-band PRBS input.
+The noise variance is set to 0.1
+}
+\keyword{datasets}
+