docs(summarize_regions): make clear that multiple functions can be used

huishenlab · Dec 6, 2024 · 775bb79 · 775bb79
1 parent 4fecd77
commit 775bb79
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/R/summarize_regions.R b/R/summarize_regions.R
@@ -7,7 +7,7 @@
 #' details.
 #' @param aligner The aligner used to produce the BED files - one of "biscuit",
 #' "bismark", "bsbolt".
-#' @param fun Function to apply over the region. See details.
+#' @param fun Function(s) to apply over the region. See details.
 #' @param mval Whether to calculate the M value (coverage \eqn{\times \beta})
 #' or use the beta value when applying the function.
 #' @param set_region_rownames Use the region strings as the returned data
@@ -54,7 +54,7 @@
 #' # make a vector of regions
 #' regions <- c("chr1:1-6", "chr1:7-10", "chr1:11-14")
 #' summarize_regions(bedfiles, regions)
-#' summarize_regions(bedfiles, regions, mval = FALSE)
+#' summarize_regions(bedfiles, regions, fun = c("mean", "stddev"), mval = FALSE)
 #' summarize_regions(bedfiles, regions, fun = "sum")
 summarize_regions <- function(
   bedfiles,

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