diff options
author | Suraj Yerramilli | 2015-01-29 21:01:24 +0530 |
---|---|---|
committer | Suraj Yerramilli | 2015-01-29 21:01:24 +0530 |
commit | b8d13d5183148e08c6441230ea4106f314f15657 (patch) | |
tree | 201a744c5b425c92cccb76e86f866b06dce77b27 /man | |
parent | bf782db25276d2b5e1cba9db0a0dc861cefe8f0b (diff) | |
download | SysID-R-code-b8d13d5183148e08c6441230ea4106f314f15657.tar.gz SysID-R-code-b8d13d5183148e08c6441230ea4106f314f15657.tar.bz2 SysID-R-code-b8d13d5183148e08c6441230ea4106f314f15657.zip |
added tUnit parameter to the reading functions
Diffstat (limited to 'man')
-rw-r--r-- | man/read.idframe.Rd | 12 | ||||
-rw-r--r-- | man/read.table.idframe.Rd | 5 | ||||
-rw-r--r-- | man/read.xls.idframe.Rd | 5 |
3 files changed, 15 insertions, 7 deletions
diff --git a/man/read.idframe.Rd b/man/read.idframe.Rd index 5a54d2d..f6d564d 100644 --- a/man/read.idframe.Rd +++ b/man/read.idframe.Rd @@ -4,21 +4,23 @@ \alias{read.idframe} \title{Data input into a idframe object} \usage{ -read.idframe(data, ninputs = 1, type = c("time", "freq")[1], Ts = 1, - freqData = FALSE) +read.idframe(data, freqData = FALSE, ninputs = 1, type = c("time", + "freq")[1], Ts = 1, tUnit = "time") } \arguments{ \item{data}{a \code{data.frame} object} +\item{freqData}{a logical value indicating whether the file contains the list of +frequencies. If \code{TRUE}, they need to be present in the first column. +(Default: \code{idframe})} + \item{ninputs}{the number of input columns. (Default: 1)} \item{type}{indicates the domain of the data (Default:\code{"time"})} \item{Ts}{sampling interval (Default: 1)} -\item{freqData}{a logical value indicating whether the file contains the list of -frequencies. If \code{TRUE}, they need to be present in the first column. -(Default: \code{idframe})} +\item{tUnit}{Time Unit (Default: "seconds")} } \value{ an idframe object diff --git a/man/read.table.idframe.Rd b/man/read.table.idframe.Rd index abd290e..f269cd4 100644 --- a/man/read.table.idframe.Rd +++ b/man/read.table.idframe.Rd @@ -5,7 +5,8 @@ \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, ...) + type = c("time", "freq")[1], Ts = 1, freqData = FALSE, tUnit = "time", + ...) } \arguments{ \item{file}{the path to the file to read} @@ -27,6 +28,8 @@ separated by this character. (Default: \code{","})} frequencies. If \code{TRUE}, they need to be present in the first column. (Default: \code{idframe})} +\item{tUnit}{Time Unit (Default: "seconds")} + \item{...}{additional arguments to be passed to the \code{\link[utils]{read.table}} function} } \value{ diff --git a/man/read.xls.idframe.Rd b/man/read.xls.idframe.Rd index e6d917c..9b5134c 100644 --- a/man/read.xls.idframe.Rd +++ b/man/read.xls.idframe.Rd @@ -5,7 +5,8 @@ \title{Read the contents of a worksheet into a idframe object} \usage{ read.xls.idframe(file, sheetName, header = TRUE, ninputs = 1, - type = c("time", "freq")[1], Ts = 1, freqData = FALSE, ...) + type = c("time", "freq")[1], Ts = 1, freqData = FALSE, tUnit = "time", + ...) } \arguments{ \item{file}{the path to the file to read} @@ -26,6 +27,8 @@ the first element of the rowIndex vector contains the names of the variables. frequencies. If \code{TRUE}, they need to be present in the first column. (Default: \code{idframe})} +\item{tUnit}{Time Unit (Default: "seconds")} + \item{...}{additional arguments to be passed to the \code{\link[xlsx]{read.xlsx2}} function} } \value{ |