add example to as.data.frame()

lschneiderbauer · Jun 15, 2024 · 033947b · 033947b
1 parent 207cf08
commit 033947b
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/R/fcwtr_scalogram.R b/R/fcwtr_scalogram.R
@@ -139,6 +139,15 @@ rm_na_time_slices <- function(x) {
 #' }
 #'
 #' @inheritParams base::as.data.frame
+#' @examples
+#' fcwt(
+#'   sin((1:5000) * 2 * pi * 440 / 44100),
+#'   sample_freq = 44100,
+#'   n_freqs = 10
+#' ) |>
+#' as.data.frame() |>
+#' head()
+#'
 #' @export
 as.data.frame.fcwtr_scalogram <- function(x, ...) {
   df <- as.data.frame(as.table(x), stringsAsFactors = FALSE)

diff --git a/man/as.data.frame.fcwtr_scalogram.Rd b/man/as.data.frame.fcwtr_scalogram.Rd