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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
#' Data input into a idframe object
#'
#' Read the contents of a data.frame/matrix into a \code{idframe} object.
#'
#' @param data a \code{data.frame} object
#' @param ninputs the number of input columns. (Default: 0)
#' @param Ts sampling interval (Default: 1)
#' @param unit Time Unit (Default: "seconds")
#'
#'
#' @return an idframe object
#' @examples
#' data(cstr)
#' data <- read.idframe(cstrData,ninputs=1,Ts= 1,unit="minutes")
#'
#' @export
read.idframe <- function(data,ninputs=NULL,Ts = 1,
unit=c("seconds","minutes","hours",
"days")[1]){
outIndex <- 1:dim(data)[2]; inputs <- NULL
if(ninputs==0){
inputs <- data[,1:ninputs,drop=F]
outIndex <- seq(ninputs+1,dim(data)[2],by=1)
}
outputs <- data[,outIndex,drop=F]
out <- idframe(output=outputs,input=inputs,Ts=Ts,unit=unit)
return(out)
}
#' Read the contents of a table-formatted file
#'
#' Read the contents of an file in table format into a \code{idframe} object.
#'
#' @param file the path to the file to read
#' @param sep the field separator character. Values on each line of the file are
#' separated by this character. (Default: \code{","})
#' @param 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})
#' @param ninputs the number of input columns. (Default: 0)
#' @param Ts sampling interval (Default: 1)
#' @param unit Time Unit (Default: "seconds")
#' @param ... additional arguments to be passed to the \code{\link[utils]{read.table}} function
#'
#' @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
#'
#' @return an 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}}
#' @export
read.table.idframe <- function(file,header=TRUE,sep=",",ninputs=0,
Ts = 1,unit=c("seconds","minutes","hours",
"days")[1],...){
# Read from file (default: csv file)
dat <- read.table(file=file,header=header,sep=sep,...)
# read from dataframe and return idframe object
out <- read.idframe(dat,ninputs=ninputs,Ts = Ts,unit=unit)
return(out)
}
#' Read the contents of a worksheet into a idframe object
#'
#' Read the contents of an excel worksheet into a \code{idframe} object.
#'
#' @param file the path to the file to read
#' @param sheetName a character string with the sheet name
#' @param header a logical value indicating whether the first row corresponding to
#' the first element of the rowIndex vector contains the names of the variables.
#' @param ninputs the number of input columns. (Default: 0)
#' @param Ts sampling interval (Default: 1)
#' @param unit Time Unit (Default: "seconds")
#' @param ... additional arguments to be passed to the \code{\link[xlsx]{read.xlsx2}} function
#'
#' @details
#'
#' The \code{read.xlsx.idframe} function uses the \code{\link[xlsx]{read.xlsx2}} function,
#' provided by the \pkg{xlsx} package, to read data from an excel file and then calls the
#' \code{\link{read.idframe}} function to read the data into a idframe object
#'
#' The function requires the java runtime to be installed on the system (Requirement of
#' the \pkg{xlsx} package).
#'
#' @return an idframe object
#' @examples
#' library(xlsx)
#' dataMatrix <- data.frame(matrix(rnorm(1000),ncol=5))
#' colnames(dataMatrix) <- c("u1","u2","y1","y2","y3")
#' write.xlsx2(dataMatrix,file="test.xlsx",row.names=FALSE)
#'
#' data <- read.xls.idframe("test.xlsx","Sheet1",ninputs=2,unit="minutes")
#'
#' @seealso \code{\link[xlsx]{read.xlsx2}}
#' @export
read.xls.idframe <- function(file,sheetName,header=TRUE,ninputs=0,
Ts = 1,unit=c("seconds","minutes","hours",
"days")[1],...){
require(xlsx)
# Read from file into an R data.frame
dat <- read.xlsx2(file=file,sheetName=sheetName,header=header,...)
l <- as.list(dat)
dat <- as.data.frame(sapply(l,as.numeric))
# read from dataframe and return idframe object
out <- read.idframe(dat,ninputs=ninputs,Ts = Ts,unit=unit)
return(out)
}
#' Reading from .odf documents
#'
#' Read the contents of an a .odf document into a \code{idframe} object.
#'
#' @param file the path to the file to read
#' @param sheetName a character string with the sheet name
#' @param header a logical value indicating whether the first row corresponding to
#' the first element of the rowIndex vector contains the names of the variables.
#' @param ninputs the number of input columns. (Default: 0)
#' @param Ts sampling interval (Default: 1)
#' @param unit Time Unit (Default: "seconds")
#' @param ... additional arguments to be passed to the \code{\link[xlsx]{read.xlsx2}} function
#'
#' @details
#'
#' The \code{read.odf.idframe} function uses the \code{\link[gnumeric]{read.gnumeric.sheet}} function,
#' provided by the \pkg{xlsx} package, to read data from a .odf file and then calls the
#' \code{\link{read.idframe}} function to read the data into a idframe object
#'
#' @return an idframe object
#'
#' @seealso \code{\link[xlsx]{read.xlsx2}}
#' @export
read.odf.idframe <- function(file,sheetName,header=TRUE,ninputs=0,
Ts = 1,unit=c("seconds","minutes","hours",
"days")[1],...){
require(gnumeric)
# Read from file into an R data.frame
dat <- read.gnumeric.sheet(file=file,sheet.name=sheetName,
head=header,...)
l <- as.list(dat)
dat <- as.data.frame(sapply(l,as.numeric))
# read from dataframe and return idframe object
out <- read.idframe(dat,ninputs=ninputs,Ts = Ts,unit=unit)
return(out)
}
|
