diff options
author | Suraj Yerramilli | 2015-06-05 15:40:14 +0530 |
---|---|---|
committer | Suraj Yerramilli | 2015-06-05 15:40:14 +0530 |
commit | 0a167c853185b9a19ab41b2f34707d138c95e849 (patch) | |
tree | 5dc865cb3ec626a1883efa3d829234facb242752 | |
parent | 10587682a7ed3389f36c61ddb8d8feef1b08c4d3 (diff) | |
download | SysID-R-code-0a167c853185b9a19ab41b2f34707d138c95e849.tar.gz SysID-R-code-0a167c853185b9a19ab41b2f34707d138c95e849.tar.bz2 SysID-R-code-0a167c853185b9a19ab41b2f34707d138c95e849.zip |
Updated Documentation
-rw-r--r-- | R/idframe.R | 5 | ||||
-rw-r--r-- | man/idframe.Rd | 6 | ||||
-rw-r--r-- | man/plot.idfrd.Rd | 15 | ||||
-rw-r--r-- | man/read.idframe.Rd | 4 |
4 files changed, 25 insertions, 5 deletions
diff --git a/R/idframe.R b/R/idframe.R index da20fa2..96d3f63 100644 --- a/R/idframe.R +++ b/R/idframe.R @@ -171,6 +171,11 @@ idfrd <- function(response,freq,Ts){ return(out) } +#' Plotting idfrd objects +#' +#' Plot method for frequency resopnse data +#' +#' @param object An object of class \code{idframe} #' @export plot.idfrd <- function(object){ require(ggplot2);require(reshape2);require(signal) diff --git a/man/idframe.Rd b/man/idframe.Rd index 3b3ba0b..cdb0f37 100644 --- a/man/idframe.Rd +++ b/man/idframe.Rd @@ -4,9 +4,9 @@ \alias{idframe} \title{S3 class for storing input-output data.} \usage{ -idframe(output = numeric(0), input = numeric(0), type = c("time", - "freq")[1], Ts = 1, t.start = 0, t.end = NA, tUnit = "seconds", - frequencies = NA, fUnit = "Hz") +idframe(output = NULL, input = NULL, type = c("time", "freq")[1], + Ts = 1, t.start = 0, t.end = NULL, tUnit = "seconds", + frequencies = NULL, fUnit = "Hz") } \arguments{ \item{output}{dataframe/matrix/vector containing the outputs} diff --git a/man/plot.idfrd.Rd b/man/plot.idfrd.Rd new file mode 100644 index 0000000..5daf85c --- /dev/null +++ b/man/plot.idfrd.Rd @@ -0,0 +1,15 @@ +% Generated by roxygen2 (4.1.1): do not edit by hand +% Please edit documentation in R/idframe.R +\name{plot.idfrd} +\alias{plot.idfrd} +\title{Plotting idfrd objects} +\usage{ +\method{plot}{idfrd}(object) +} +\arguments{ +\item{object}{An object of class \code{idframe}} +} +\description{ +Plot method for frequency resopnse data +} + diff --git a/man/read.idframe.Rd b/man/read.idframe.Rd index b3906c4..4bccd8e 100644 --- a/man/read.idframe.Rd +++ b/man/read.idframe.Rd @@ -4,7 +4,7 @@ \alias{read.idframe} \title{Data input into a idframe object} \usage{ -read.idframe(data, freqData = FALSE, ninputs = 1, type = c("time", +read.idframe(data, freqData = FALSE, ninputs = NULL, type = c("time", "freq")[1], Ts = 1, tUnit = "sec") } \arguments{ @@ -14,7 +14,7 @@ read.idframe(data, freqData = FALSE, ninputs = 1, 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: 1)} +\item{ninputs}{the number of input columns. (Default: NULL)} \item{type}{indicates the domain of the data (Default:\code{"time"})} |