From cff6c8dc1484982c3ca4d22066d678e1cdf063db Mon Sep 17 00:00:00 2001 From: Lukas Schneiderbauer Date: Thu, 2 Jan 2025 22:26:48 +0100 Subject: [PATCH] improve doc --- R/fcwt.R | 5 +++-- man/fcwt.Rd | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/R/fcwt.R b/R/fcwt.R index 9d4ea65..8bc23d7 100644 --- a/R/fcwt.R +++ b/R/fcwt.R @@ -2,8 +2,9 @@ #' #' The core function of this package making use of the fCWT library. It processes #' an input signal in form of a real valued numeric vector interpreted as an -#' evenly spaced time series and returns the absolute values of a spectogram, -#' i.e. a graph with a time and a frequency dimension. +#' evenly spaced time series and returns the absolute values of the continuous +#' wavelet transform, i.e. a real valued positive matrix with a time and a +#' frequency dimension. #' #' @details #' The wavelet used in this calculation is the so called Morlet wavelet, diff --git a/man/fcwt.Rd b/man/fcwt.Rd index 98adf3a..38a5098 100644 --- a/man/fcwt.Rd +++ b/man/fcwt.Rd @@ -85,8 +85,9 @@ data format. \description{ The core function of this package making use of the fCWT library. It processes an input signal in form of a real valued numeric vector interpreted as an -evenly spaced time series and returns the absolute values of a spectogram, -i.e. a graph with a time and a frequency dimension. +evenly spaced time series and returns the absolute values of the continuous +wavelet transform, i.e. a real valued positive matrix with a time and a +frequency dimension. } \details{ The wavelet used in this calculation is the so called Morlet wavelet,