diff options
author | Suraj Yerramilli | 2015-01-29 18:29:30 +0530 |
---|---|---|
committer | Suraj Yerramilli | 2015-01-29 18:29:30 +0530 |
commit | a40960ddec1b0d649f48806dea18f6506b269374 (patch) | |
tree | 604afb5b94b7112804fb3ff3b3f3f7b0c72ee8ae | |
parent | ce5175a0deb3b1b4e46f66ef135672be022f267c (diff) | |
download | SysID-R-code-a40960ddec1b0d649f48806dea18f6506b269374.tar.gz SysID-R-code-a40960ddec1b0d649f48806dea18f6506b269374.tar.bz2 SysID-R-code-a40960ddec1b0d649f48806dea18f6506b269374.zip |
minor changes in documentation
-rw-r--r-- | R/idframe.R | 12 | ||||
-rw-r--r-- | man/plot.idframe.Rd | 6 | ||||
-rw-r--r-- | man/summary.idframe.Rd | 6 |
3 files changed, 12 insertions, 12 deletions
diff --git a/R/idframe.R b/R/idframe.R index 504478b..15752da 100644 --- a/R/idframe.R +++ b/R/idframe.R @@ -60,10 +60,10 @@ idframe <- function(output=numeric(0),input=numeric(0), #' Plotting idframe objects #' -#' Plotting method for objects inherting from class "idframe" +#' Plotting method for objects inherting from class \code{idframe} #' -#' @param object an object of class "idframe" -#' @param ... additional arguments to be passed to the `plot` function +#' @param object an object of class \code{idframe} +#' @param ... additional arguments to be passed to the \code{plot} function #' @export plot.idframe <- function(object,...){ @@ -99,11 +99,11 @@ plot.idframe <- function(object,...){ } } -#' idframe-Object summaries +#' idframe-object summaries #' -#' Generates a summary of objects inherting from class `idframe` +#' Generates a summary of objects inherting from class \code{idframe} #' -#' @param object an object of class "idframe" +#' @param object an object of class \code{idframe} #' @export summary.idframe <- function(object){ out_sum <- summary(object$output) diff --git a/man/plot.idframe.Rd b/man/plot.idframe.Rd index 559330a..3efbf55 100644 --- a/man/plot.idframe.Rd +++ b/man/plot.idframe.Rd @@ -7,11 +7,11 @@ \method{plot}{idframe}(object, ...) } \arguments{ -\item{object}{an object of class "idframe"} +\item{object}{an object of class \code{idframe}} -\item{...}{additional arguments to be passed to the `plot` function} +\item{...}{additional arguments to be passed to the \code{plot} function} } \description{ -Plotting method for objects inherting from class "idframe" +Plotting method for objects inherting from class \code{idframe} } diff --git a/man/summary.idframe.Rd b/man/summary.idframe.Rd index 95ba73a..d54215c 100644 --- a/man/summary.idframe.Rd +++ b/man/summary.idframe.Rd @@ -2,14 +2,14 @@ % Please edit documentation in R/idframe.R \name{summary.idframe} \alias{summary.idframe} -\title{idframe-Object summaries} +\title{idframe-object summaries} \usage{ \method{summary}{idframe}(object) } \arguments{ -\item{object}{an object of class "idframe"} +\item{object}{an object of class \code{idframe}} } \description{ -Generates a summary of objects inherting from class `idframe` +Generates a summary of objects inherting from class \code{idframe} } |