diff --git a/R/fcwtr_scalogram.R b/R/fcwtr_scalogram.R index d0ac999..7474252 100644 --- a/R/fcwtr_scalogram.R +++ b/R/fcwtr_scalogram.R @@ -262,6 +262,8 @@ rbind.fcwtr_scalogram <- function(...) { #' @param x The "fcwtr_scalogram" object resulting from [fcwt()] to print. #' @inheritParams base::print #' +#' @return Returns the argument `x` invisibly. +#' #' @export print.fcwtr_scalogram <- function(x, ...) { cat("_Scalogram_\n") @@ -342,6 +344,8 @@ as.data.frame.fcwtr_scalogram <- function(x, ...) { #' An "fcwtr_scalogram" object resulting from [fcwt()]. #' @inheritParams base::as.matrix #' +#' @return A two dimensional numeric vector, inheriting the S3 class "matrix". +#' #' @examples #' fcwt( #' sin((1:5000) * 2 * pi * 440 / 44100), diff --git a/man/as.matrix.fcwtr_scalogram.Rd b/man/as.matrix.fcwtr_scalogram.Rd index e9c58f9..f80d27d 100644 --- a/man/as.matrix.fcwtr_scalogram.Rd +++ b/man/as.matrix.fcwtr_scalogram.Rd @@ -11,6 +11,9 @@ \item{...}{additional arguments to be passed to or from methods.} } +\value{ +A two dimensional numeric vector, inheriting the S3 class "matrix". +} \description{ Strips attributes and class from a scalogram object to retrieve a pure matrix. diff --git a/man/print.fcwtr_scalogram.Rd b/man/print.fcwtr_scalogram.Rd index 10561fe..675cf3a 100644 --- a/man/print.fcwtr_scalogram.Rd +++ b/man/print.fcwtr_scalogram.Rd @@ -11,6 +11,9 @@ \item{...}{further arguments passed to or from other methods.} } +\value{ +Returns the argument \code{x} invisibly. +} \description{ \code{print()} prints its argument and returns it invisibly (via \code{invisible(x)}). }