add a bunch of roxygen examples

R/fcwt.R

@@ -76,15 +76,14 @@
 #' @examples
 #' ts_sin_440 <- sin((1:5000) * 2 * pi * 440 / 44100)
 #'
-#' res <-
-#'   fcwt(
-#'     ts_sin_440,
-#'     sample_freq = u(44.1, "kHz"),
-#'     freq_begin = u(50, "Hz"),
-#'     freq_end = u(1000, "Hz"),
-#'     n_freqs = 10,
-#'     sigma = 5
-#'   )
+#' fcwt(
+#'   ts_sin_440,
+#'   sample_freq = u(44.1, "kHz"),
+#'   freq_begin = u(50, "Hz"),
+#'   freq_end = u(1000, "Hz"),
+#'   n_freqs = 10,
+#'   sigma = 5
+#' )
 #' @export
 fcwt <- function(signal,
                  sample_freq,
@@ -134,7 +133,8 @@ fcwt <- function(signal,
 
   sc <-
     fcwtr_scalogram(
-      output, time_offset = u(0, "s"), sample_freq, freq_begin, freq_end,
+      output,
+      time_offset = u(0, "s"), sample_freq, freq_begin, freq_end,
       freq_scale, sigma
     )
 

R/fcwtr_scalogram.R

@@ -196,6 +196,26 @@ sc_agg <- function(x, wnd) {
 #'
 #' @return Returns a new time-wise combined "fcwtr_scalogram" object.
 #'
+#' @examples
+#' ts_sin_440 <- sin((1:5000) * 2 * pi * 440 / 44100)
+#'
+#' res <-
+#'   fcwt(
+#'     ts_sin_440,
+#'     sample_freq = u(44.1, "kHz"),
+#'     freq_begin = u(50, "Hz"),
+#'     freq_end = u(1000, "Hz"),
+#'     n_freqs = 10,
+#'     sigma = 5
+#'   )
+#'
+#' print(res)
+#'
+#' # doubled scalogram
+#' res_doubled <- rbind(res, res)
+#'
+#' print(res_doubled)
+#'
 #' @export
 rbind.fcwtr_scalogram <- function(...) {
   args <- list(...)
@@ -322,6 +342,14 @@ as.data.frame.fcwtr_scalogram <- function(x, ...) {
 #'  An "fcwtr_scalogram" object resulting from [fcwt()].
 #' @inheritParams base::as.matrix
 #'
+#' @examples
+#' fcwt(
+#'   sin((1:5000) * 2 * pi * 440 / 44100),
+#'   sample_freq = 44100,
+#'   n_freqs = 10
+#' ) |>
+#'   as.matrix()
+#'
 #' @export
 as.matrix.fcwtr_scalogram <- function(x, ...) {
   attributes(x) <- NULL
@@ -352,6 +380,13 @@ as.matrix.fcwtr_scalogram <- function(x, ...) {
 #' @return
 #'  Another "fcwtr_scalogram" object that contains only part of the data.
 #'
+#' @examples
+#' fcwt(
+#'   sin((1:5000) * 2 * pi * 440 / 44100),
+#'   sample_freq = 44100,
+#'   n_freqs = 10
+#' )[1:1000, 2:7]
+#'
 #' @export
 `[.fcwtr_scalogram` <- function(x, i, j) {
   if (!missing(i)) {