documentation update

6 files changed, 37 insertions, 2 deletions

diff --git a/man/idframe.Rd b/man/idframe.Rd
index c9d8e7b..29276bf 100644
--- a/man/idframe.Rd
+++ b/man/idframe.Rd
@@ -34,4 +34,12 @@ an idframe object
 \description{
 \code{idframe} is an S3 class for storing and manipulating input-ouput data. It supports discrete time and frequency domain data.
 }
+\examples{
+dataMatrix <- matrix(rnorm(1000),ncol=5)
+data <- idframe(output=dataMatrix[,3:5],input=dataMatrix[,1:2],Ts=1)
+}
+\seealso{
+\code{\link{plot.idframe}}, the plot method for idframe objects,
+\code{\link{summary.idframe}}, the summary method for idrame objects
+}
 
diff --git a/man/plot.idframe.Rd b/man/plot.idframe.Rd
index 3efbf55..86e2600 100644
--- a/man/plot.idframe.Rd
+++ b/man/plot.idframe.Rd
@@ -14,4 +14,8 @@
 \description{
 Plotting method for objects inherting from class \code{idframe}
 }
+\examples{
+data(distill)
+plot(distill,col="blue")
+}
 
diff --git a/man/read.idframe.Rd b/man/read.idframe.Rd
index ac3c00a..24546df 100644
--- a/man/read.idframe.Rd
+++ b/man/read.idframe.Rd
@@ -5,7 +5,7 @@
 \title{Data input into a idframe object}
 \usage{
 read.idframe(data, freqData = FALSE, ninputs = 1, type = c("time",
-  "freq")[1], Ts = 1, tUnit = "time")
+  "freq")[1], Ts = 1, tUnit = "sec")
 }
 \arguments{
 \item{data}{a \code{data.frame} object}
@@ -32,4 +32,8 @@ Read the contents of a \code{data.frame} object into a \code{idframe} object.
 If \code{type="freq"} and \code{freqData = TRUE}, then the first column in the file
 should contain the frequencies.
 }
+\examples{
+data(cstr)
+data <- read.idframe(cstrData,ninputs=1,type="time",Ts= 1,tUnit="min")
+}
 
diff --git a/man/read.table.idframe.Rd b/man/read.table.idframe.Rd
index f269cd4..276b32a 100644
--- a/man/read.table.idframe.Rd
+++ b/man/read.table.idframe.Rd
@@ -5,7 +5,7 @@
 \title{Data input into a idframe object}
 \usage{
 read.table.idframe(file, header = TRUE, sep = ",", ninputs = 1,
-  type = c("time", "freq")[1], Ts = 1, freqData = FALSE, tUnit = "time",
+  type = c("time", "freq")[1], Ts = 1, freqData = FALSE, tUnit = "sec",
   ...)
 }
 \arguments{
@@ -47,6 +47,13 @@ provided by the \pkg{xlsx} package, to read data from an excel file and then cal
 If \code{type="freq"} and \code{freqData = TRUE}, then the first column in the file
 should contain the frequencies.
 }
+\examples{
+dataMatrix <- data.frame(matrix(rnorm(1000),ncol=5))
+colnames(dataMatrix) <- c("u1","u2","y1","y2","y3")
+write.csv(dataMatrix,file="test.csv",row.names=F)
+
+data <- read.table.idframe("test.csv",ninputs=2,tUnit="min")
+}
 \seealso{
 \code{\link[utils]{read.table}}
 }
diff --git a/man/read.xls.idframe.Rd b/man/read.xls.idframe.Rd
index 9b5134c..84ce4f9 100644
--- a/man/read.xls.idframe.Rd
+++ b/man/read.xls.idframe.Rd
@@ -50,6 +50,14 @@ should contain the frequencies.
 The function requires the java runtime to be installed on the system (Requirement of
 the \pkg{xlsx} package).
 }
+\examples{
+library(xlsx)
+dataMatrix <- data.frame(matrix(rnorm(1000),ncol=5))
+colnames(dataMatrix) <- c("u1","u2","y1","y2","y3")
+write.xlsx2(dataMatrix,file="test.xlsx",row.names=F)
+
+data <- read.xls.idframe("test.xlsx","Sheet1",ninputs=2,tUnit="min")
+}
 \seealso{
 \code{\link[xlsx]{read.xlsx2}}
 }
diff --git a/man/summary.idframe.Rd b/man/summary.idframe.Rd
index d54215c..e28372b 100644
--- a/man/summary.idframe.Rd
+++ b/man/summary.idframe.Rd
@@ -12,4 +12,8 @@
 \description{
 Generates a summary of objects inherting from class \code{idframe}
 }
+\examples{
+data(cstr)
+summary(cstr)
+}