diff options
Diffstat (limited to 'R')
| -rw-r--r-- | R/idframe.R | 17 |
1 files changed, 14 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) |