summaryrefslogtreecommitdiff
path: root/man/read.table.idframe.Rd
diff options
context:
space:
mode:
authorSuraj Yerramilli2015-06-06 21:23:07 +0530
committerSuraj Yerramilli2015-06-06 21:23:07 +0530
commit9f0119c7470bac5ff4d3dbaf0e0f3f73846f1760 (patch)
tree67bb65351780fdcb04cd5c0a0275a3e03633d7a4 /man/read.table.idframe.Rd
parent89d18e89331dfcb33aa08ef79d04bf07ccc8e971 (diff)
downloadSysID-R-code-9f0119c7470bac5ff4d3dbaf0e0f3f73846f1760.tar.gz
SysID-R-code-9f0119c7470bac5ff4d3dbaf0e0f3f73846f1760.tar.bz2
SysID-R-code-9f0119c7470bac5ff4d3dbaf0e0f3f73846f1760.zip
Updated documentation for the data reading functions
Diffstat (limited to 'man/read.table.idframe.Rd')
-rw-r--r--man/read.table.idframe.Rd10
1 files changed, 5 insertions, 5 deletions
diff --git a/man/read.table.idframe.Rd b/man/read.table.idframe.Rd
index d3b5605..73f4082 100644
--- a/man/read.table.idframe.Rd
+++ b/man/read.table.idframe.Rd
@@ -2,9 +2,9 @@
% Please edit documentation in R/readData.R
\name{read.table.idframe}
\alias{read.table.idframe}
-\title{Data input into a idframe object}
+\title{Read the contents of a table-formatted file}
\usage{
-read.table.idframe(file, header = TRUE, sep = ",", ninputs = 1,
+read.table.idframe(file, header = TRUE, sep = ",", ninputs = NULL,
type = c("time", "freq")[1], Ts = 1, freqData = FALSE, tUnit = "sec",
...)
}
@@ -18,7 +18,7 @@ the first element of the rowIndex vector contains the names of the variables.
\item{sep}{the field separator character. Values on each line of the file are
separated by this character. (Default: \code{","})}
-\item{ninputs}{the number of input columns. (Default: 1)}
+\item{ninputs}{the number of input columns. (Default: \code{NULL})}
\item{type}{indicates the domain of the data (Default:\code{"time"})}
@@ -39,8 +39,8 @@ an idframe object
Read the contents of an file in table format into a \code{idframe} object.
}
\details{
-The \code{readxlsx.idframe} function uses the \code{\link[utils]{read.table}} function,
-provided by the \pkg{xlsx} package, to read data from an excel file and then calls the
+The \code{read.table.idframe} function uses the \code{\link[utils]{read.table}} function,
+provided by the \pkg{utils} package, to read data from a table-formatted file and then calls the
\code{\link{read.idframe}} function to read the data into a idframe object