diff options
-rw-r--r-- | R/idframe.R | 12 | ||||
-rw-r--r-- | man/idframe.Rd | 18 |
2 files changed, 9 insertions, 21 deletions
diff --git a/R/idframe.R b/R/idframe.R index 15b3638..6cc0483 100644 --- a/R/idframe.R +++ b/R/idframe.R @@ -4,14 +4,11 @@ #' #' @param output dataframe/matrix/vector containing the outputs #' @param input dataframe/matrix/vector containing the inputs -#' @param type indicates the domain of the data (Default:"time") #' @param Ts sampling interval (Default: 1) -#' @param t.start Starting time (Valid only if type="time") -#' @param t.end End time. Optional Argument (Valid only if type="time") -#' @param tUnit Time Unit (Default: "seconds") -#' @param frequencies Vector containing the list of frequencies at which the data was -#' recorded (Valid only if type="frequency") -#' @param fUnit Frequency Unit (Valid only if type="frequency") +#' @param start Time of the first observation +#' @param t.end Time of the last observation Optional Argument +#' @param unit Time Unit (Default: "seconds") +#' #' @return an idframe object #' #' @seealso \code{\link{plot.idframe}}, the plot method for idframe objects, @@ -69,7 +66,6 @@ plot.idframe <- function(object,par=list(mar=c(3,4,2,2)), data <- cbind(object$output,object$input) } tfplot(data,Xaxis=NULL,par=par,col=col,...) - } } #' @export diff --git a/man/idframe.Rd b/man/idframe.Rd index cdb0f37..9af8540 100644 --- a/man/idframe.Rd +++ b/man/idframe.Rd @@ -4,29 +4,21 @@ \alias{idframe} \title{S3 class for storing input-output data.} \usage{ -idframe(output = NULL, input = NULL, type = c("time", "freq")[1], - Ts = 1, t.start = 0, t.end = NULL, tUnit = "seconds", - frequencies = NULL, fUnit = "Hz") +idframe(output = NULL, input = NULL, Ts = 1, start = 0, end = NULL, + unit = c("seconds", "minutes", "hours", "days", "hours")[1]) } \arguments{ \item{output}{dataframe/matrix/vector containing the outputs} \item{input}{dataframe/matrix/vector containing the inputs} -\item{type}{indicates the domain of the data (Default:"time")} - \item{Ts}{sampling interval (Default: 1)} -\item{t.start}{Starting time (Valid only if type="time")} - -\item{t.end}{End time. Optional Argument (Valid only if type="time")} - -\item{tUnit}{Time Unit (Default: "seconds")} +\item{start}{Time of the first observation} -\item{frequencies}{Vector containing the list of frequencies at which the data was -recorded (Valid only if type="frequency")} +\item{unit}{Time Unit (Default: "seconds")} -\item{fUnit}{Frequency Unit (Valid only if type="frequency")} +\item{t.end}{Time of the last observation Optional Argument} } \value{ an idframe object |