diff options
author | Suraj Yerramilli | 2015-12-30 20:37:37 +0530 |
---|---|---|
committer | Suraj Yerramilli | 2015-12-30 20:37:37 +0530 |
commit | 4eefced3dffd4fb2a8d8a02628ea04f5197e8ee0 (patch) | |
tree | 20c0a83758d10816c2f312afb8cef3ab293956c8 /man/read.xls.idframe.Rd | |
parent | a6288c34f0a76b1cb47b443f01cde075f6a221a4 (diff) | |
download | SysID-R-code-4eefced3dffd4fb2a8d8a02628ea04f5197e8ee0.tar.gz SysID-R-code-4eefced3dffd4fb2a8d8a02628ea04f5197e8ee0.tar.bz2 SysID-R-code-4eefced3dffd4fb2a8d8a02628ea04f5197e8ee0.zip |
minor documentation updates
Diffstat (limited to 'man/read.xls.idframe.Rd')
-rw-r--r-- | man/read.xls.idframe.Rd | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/man/read.xls.idframe.Rd b/man/read.xls.idframe.Rd index 449ccf9..a7123bb 100644 --- a/man/read.xls.idframe.Rd +++ b/man/read.xls.idframe.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/readData.R \name{read.xls.idframe} \alias{read.xls.idframe} @@ -12,7 +12,7 @@ read.xls.idframe(file, sheetName, header = TRUE, ninputs = 0, Ts = 1, \item{sheetName}{a character string with the sheet name} -\item{header}{a logical value indicating whether the first row corresponding to +\item{header}{a logical value indicating whether the first row corresponding to the first element of the rowIndex vector contains the names of the variables.} \item{ninputs}{the number of input columns. (Default: 0)} @@ -30,11 +30,11 @@ an idframe object Read the contents of an excel worksheet into a \code{idframe} object. } \details{ -The \code{read.xlsx.idframe} function uses the \code{\link[xlsx]{read.xlsx2}} function, -provided by the \pkg{xlsx} package, to read data from an excel file and then calls the +The \code{read.xlsx.idframe} function uses the \code{\link[xlsx]{read.xlsx2}} function, +provided by the \pkg{xlsx} package, to read data from an excel file and then calls the \code{\link{read.idframe}} function to read the data into a idframe object -The function requires the java runtime to be installed on the system (Requirement of +The function requires the java runtime to be installed on the system (Requirement of the \pkg{xlsx} package). } \examples{ @@ -42,8 +42,9 @@ 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=FALSE) - + data <- read.xls.idframe("test.xlsx","Sheet1",ninputs=2,unit="minutes") + } \seealso{ \code{\link[xlsx]{read.xlsx2}} |