downsample doc polishing

jefferislab · Jul 16, 2024 · ccf862a · ccf862a
1 parent 4620add
commit ccf862a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/R/gsignal.R b/R/gsignal.R
@@ -1,11 +1,15 @@
 #' Downsample a signal by an integer factor
 #'
+#' @details This provides a simple wrapper around the [gsignal::downsample()]
+#' function with support for the time series functionality found in the base R
+#' [stats::ts()] functions and friends.
+#'
 #' @inheritParams gsignal::downsample
 #' @return
 #' @export
 #' @importFrom stats is.ts is.mts deltat start
 #' @importFrom gsignal downsample
-#'
+#' @seealso [stats::ts()], [gsignal::downsample()]
 #' @examples
 #' x=1:10
 #' x

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