improve doc

lschneiderbauer · Jan 2, 2025 · cff6c8d · cff6c8d
1 parent 19f73e3
commit cff6c8d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git 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