add autoplot example

lschneiderbauer · Dec 27, 2024 · b2722f0 · b2722f0
1 parent bd74c30
commit b2722f0
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/R/fcwtr_scalogram.R b/R/fcwtr_scalogram.R
@@ -469,6 +469,21 @@ plot.fcwtr_scalogram <- function(x, n = 1000, time_unit = "s", freq_unit = "Hz",
 #' @return
 #'  A ggplot object.
 #'
+#' @examplesIf requireNamespace("ggplot2", quietly = TRUE)
+#' library(ggplot2)
+#'
+#' res <-
+#'   fcwt(
+#'     sin((1:4410) * 2 * pi * 440 / 44100),
+#'     sample_freq = 44100,
+#'     freq_begin = 50,
+#'     freq_end = 1000,
+#'     n_freqs = 10,
+#'     sigma = 5
+#'   )
+#'
+#' autoplot(res, time_unit = "ms")
+#'
 #' @export
 autoplot.fcwtr_scalogram <- function(object, n = 1000,
                                      time_unit = "s", freq_unit = "Hz", ...) {

diff --git a/man/autoplot.fcwtr_scalogram.Rd b/man/autoplot.fcwtr_scalogram.Rd