update doc

lschneiderbauer · May 20, 2024 · 8ed8452 · 8ed8452
1 parent e563e48
commit 8ed8452
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 3 deletions.
diff --git a/R/fcwt_batch.R b/R/fcwt_batch.R
@@ -39,6 +39,19 @@
 #' @inheritParams fcwt
 #' @importFrom utils txtProgressBar setTxtProgressBar
 #' @export
+#' @examples
+#' res <-
+#'   fcwt_batch(
+#'     ts_sin_sin,
+#'     sample_freq = 44100,
+#'     freq_begin = 100,
+#'     freq_end = 11000,
+#'     n_freqs = 300,
+#'     sigma = 10,
+#'     max_batch_size = 20000,
+#'     time_resolution = 0.001
+#'   )
+#'
 fcwt_batch <- function(signal,
                        sample_freq,
                        freq_begin,
@@ -102,9 +115,6 @@ fcwt_batch <- function(signal,
     diff <- end - cursor
 
     if (!is.null(total_result)) {
-      #print(attr(total_result, "sample_freq"))
-      #print(attr(result, "sample_freq"))
-
       total_result <-
         tbind(
           total_result,

diff --git a/man/fcwt_batch.Rd b/man/fcwt_batch.Rd