Documenting plot.idfrd

2 files changed, 20 insertions, 2 deletions

diff --git a/R/idframe.R b/R/idframe.R
index 80a4f91..a4bebdd 100644
--- a/R/idframe.R
+++ b/R/idframe.R
@@ -190,9 +190,18 @@ idfrd <- function(response,freq,Ts){
 
 #' Plotting idfrd objects
 #' 
-#' Plot method for frequency resopnse data
+#' Generates the bode plot of the given frequency response data. It uses the
+#' ggplot2 plotting engine
 #' 
 #' @param object An object of class \code{idframe}
+#' 
+#' @seealso \code{\link[ggplot2]{ggplot}}
+#' 
+#' @examples
+#' data(frf)
+#' frf <- spa(data) # Estimates the frequency response from data
+#' plot(frf)
+#' 
 #' @export
 plot.idfrd <- function(object){
   require(ggplot2);require(reshape2);require(signal)
diff --git a/man/plot.idfrd.Rd b/man/plot.idfrd.Rd
index 5daf85c..0c7d662 100644
--- a/man/plot.idfrd.Rd
+++ b/man/plot.idfrd.Rd
@@ -10,6 +10,15 @@
 \item{object}{An object of class \code{idframe}}
 }
 \description{
-Plot method for frequency resopnse data
+Generates the bode plot of the given frequency response data. It uses the
+ggplot2 plotting engine
+}
+\examples{
+data(frf)
+frf <- spa(data) # Estimates the frequency response from data
+plot(frf)
+}
+\seealso{
+\code{\link[ggplot2]{ggplot}}
 }