From 4eefced3dffd4fb2a8d8a02628ea04f5197e8ee0 Mon Sep 17 00:00:00 2001 From: Suraj Yerramilli Date: Wed, 30 Dec 2015 20:37:37 +0530 Subject: minor documentation updates --- man/read.table.idframe.Rd | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) (limited to 'man/read.table.idframe.Rd') diff --git a/man/read.table.idframe.Rd b/man/read.table.idframe.Rd index 5065317..ca80a4c 100644 --- a/man/read.table.idframe.Rd +++ b/man/read.table.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.table.idframe} \alias{read.table.idframe} @@ -10,11 +10,11 @@ read.table.idframe(file, header = TRUE, sep = ",", ninputs = 0, Ts = 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. +\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 +\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)} @@ -32,16 +32,17 @@ an idframe object 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 +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}} -- cgit