summaryrefslogtreecommitdiff
path: root/man/read.table.idframe.Rd
blob: ca80a4c0b7fdc6bf8adbe06db79c31c0c1b90706 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/readData.R
\name{read.table.idframe}
\alias{read.table.idframe}
\title{Read the contents of a table-formatted file}
\usage{
read.table.idframe(file, header = TRUE, sep = ",", ninputs = 0, Ts = 1,
  unit = c("seconds", "minutes", "hours", "days")[1], ...)
}
\arguments{
\item{file}{the path to the file to read}

\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. 
(Default: \code{TRUE})}

\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: 0)}

\item{Ts}{sampling interval (Default: 1)}

\item{unit}{Time Unit (Default: "seconds")}

\item{...}{additional arguments to be passed to the \code{\link[utils]{read.table}} function}
}
\value{
an idframe object
}
\description{
Read the contents of an file in table format into a \code{idframe} object.
}
\details{
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
}
\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=FALSE)
 
data <- read.table.idframe("test.csv",ninputs=2,unit="minutes")

}
\seealso{
\code{\link[utils]{read.table}}
}