added documentation for plot and summary functions of the idframe class

3 files changed, 46 insertions, 3 deletions

diff --git a/R/idframe.R b/R/idframe.R
index 00199ea..504478b 100644
--- a/R/idframe.R
+++ b/R/idframe.R
@@ -58,7 +58,13 @@ idframe <- function(output=numeric(0),input=numeric(0),
   return(dat)
 }
 
-# plot method for idframe object
+#' Plotting idframe objects
+#' 
+#' Plotting method for objects inherting from class "idframe"
+#' 
+#' @param object an object of class "idframe"
+#' @param ... additional arguments to be passed to the `plot` function
+#' @export
 plot.idframe <- function(object,...){
   
   p <- dim(object$output)[2];m <- dim(object$input)[2]
@@ -93,8 +99,13 @@ plot.idframe <- function(object,...){
   }
 }
 
-# summary method for idframe object
-summary.idframe <- function(object,...){
+#' idframe-Object summaries
+#' 
+#' Generates a summary of objects inherting from class `idframe`
+#' 
+#' @param object an object of class "idframe"
+#' @export
+summary.idframe <- function(object){
   out_sum <- summary(object$output)
   in_sum <- summary(object$input)
   
diff --git a/man/plot.idframe.Rd b/man/plot.idframe.Rd
new file mode 100644
index 0000000..559330a
--- /dev/null
+++ b/man/plot.idframe.Rd
@@ -0,0 +1,17 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/idframe.R
+\name{plot.idframe}
+\alias{plot.idframe}
+\title{Plotting idframe objects}
+\usage{
+\method{plot}{idframe}(object, ...)
+}
+\arguments{
+\item{object}{an object of class "idframe"}
+
+\item{...}{additional arguments to be passed to the `plot` function}
+}
+\description{
+Plotting method for objects inherting from class "idframe"
+}
+
diff --git a/man/summary.idframe.Rd b/man/summary.idframe.Rd
new file mode 100644
index 0000000..95ba73a
--- /dev/null
+++ b/man/summary.idframe.Rd
@@ -0,0 +1,15 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/idframe.R
+\name{summary.idframe}
+\alias{summary.idframe}
+\title{idframe-Object summaries}
+\usage{
+\method{summary}{idframe}(object)
+}
+\arguments{
+\item{object}{an object of class "idframe"}
+}
+\description{
+Generates a summary of objects inherting from class `idframe`
+}
+