update doc and roxygen

DESCRIPTION

@@ -33,3 +33,4 @@ SystemRequirements:
     openmp (>= 15.0.0)
 Config/testthat/edition: 3
 URL: https://lschneiderbauer.github.io/fcwtr/
+Roxygen: list(markdown = TRUE)

R/fcwt.R

@@ -1,4 +1,4 @@
-#' Performs a fast continuous wavelet transform.
+#' Fast continuous wavelet transform
 #'
 #' 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
@@ -17,12 +17,12 @@
 #'  Sampling rate of input time series in physical units.
 #'
 #' @param freq_begin
-#'  Sets the minimal frequency (\code{> 0}!), in same units as \code{sample_freq},
+#'  Sets the minimal frequency (`> 0`), in same units as `sample_freq`,
 #'  that should be contained in the output.
 #'
 #' @param freq_end
-#'  Sets the maximal frequency (\code{> freq_begin}!), in same units as
-#'  \code{sample_freq}, that should be contained in the output.
+#'  Sets the maximal frequency (`> freq_begin`), in same units as
+#'  `sample_freq`, that should be contained in the output.
 #'
 #' @param n_freqs
 #'  Number of frequency bins generated by the CWT. The frequencies
@@ -51,7 +51,7 @@
 #'  Number of threads used by the computation, if applicable.
 #'
 #' @return
-#'  A numeric real-valued matrix with \code{dim = c(length(signal), n_freqs)}.
+#'  A numeric real-valued matrix with `dim = c(length(signal), n_freqs)`.
 #'
 #' @examples
 #' ts_sin_440 <- sin((1:44100) * 2 * pi * 440 / 44100)

R/fcwt_batch.R

@@ -1,11 +1,11 @@
-#' FCWT on long sequences
+#' Automatic batching of fcwt calculations on long sequences
 #'
 #' Performs a fast continuous wavelet transform on long sequences. It should
-#' not be used on short sequences, since boundary artefacts are discarded, and
-#' those potentially dominate for short sequences.
+#' not be used on short sequences since boundary artefacts are discarded (and
+#' those potentially dominate for short sequences.)
 #'
 #' @details
-#' In case of input sequences that exceed the a certain size, the outputl
+#' In case of input sequences that exceed the a certain size, the output
 #' sequence will not fit into the local memory and the fcwt cannot be
 #' performed in one run.
 #' For instance, in case of processing a song of 10 minutes length (assuming
@@ -37,6 +37,7 @@
 #'  Can not be higher than the time resolution of the input signal.
 #'
 #' @inheritParams fcwt
+#' @seealso fcwt
 #' @importFrom utils txtProgressBar setTxtProgressBar
 #' @export
 #' @examples