summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/read.idframe.Rd4
-rw-r--r--man/read.table.idframe.Rd10
-rw-r--r--man/read.xls.idframe.Rd4
3 files changed, 9 insertions, 9 deletions
diff --git a/man/read.idframe.Rd b/man/read.idframe.Rd
index 4bccd8e..216c074 100644
--- a/man/read.idframe.Rd
+++ b/man/read.idframe.Rd
@@ -14,7 +14,7 @@ read.idframe(data, freqData = FALSE, ninputs = NULL, type = c("time",
frequencies. If \code{TRUE}, they need to be present in the first column.
(Default: \code{idframe})}
-\item{ninputs}{the number of input columns. (Default: NULL)}
+\item{ninputs}{the number of input columns. (Default: \code{NULL})}
\item{type}{indicates the domain of the data (Default:\code{"time"})}
@@ -26,7 +26,7 @@ frequencies. If \code{TRUE}, they need to be present in the first column.
an idframe object
}
\description{
-Read the contents of a \code{data.frame} object into a \code{idframe} object.
+Read the contents of a data.frame/matrix into a \code{idframe} object.
}
\details{
If \code{type="freq"} and \code{freqData = TRUE}, then the first column in the file
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
diff --git a/man/read.xls.idframe.Rd b/man/read.xls.idframe.Rd
index f4ba64c..2404b10 100644
--- a/man/read.xls.idframe.Rd
+++ b/man/read.xls.idframe.Rd
@@ -4,7 +4,7 @@
\alias{read.xls.idframe}
\title{Read the contents of a worksheet into a idframe object}
\usage{
-read.xls.idframe(file, sheetName, header = TRUE, ninputs = 1,
+read.xls.idframe(file, sheetName, header = TRUE, ninputs = NULL,
type = c("time", "freq")[1], Ts = 1, freqData = FALSE, tUnit = "time",
...)
}
@@ -17,7 +17,7 @@ read.xls.idframe(file, sheetName, header = TRUE, ninputs = 1,
the first element of the rowIndex vector contains the names of the variables.
(Default: \code{TRUE})}
-\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"})}