Browse code

Added missing argument docs

shians authored on 15/10/2020 00:43:42
Showing 1 changed files

... ...
@@ -1,9 +1,13 @@
1 1
 #' Plot aggregate regions
2 2
 #'
3 3
 #' @param x the NanoMethResult object.
4
-#' @param regions a table of regions or GRanges, or a list of such objects. The table of regions must contain chr, start and end columns.
5
-#' @param groups if 'features' is a list, a vector of characters of the same length as the list containing names for each member.
4
+#' @param regions a table of regions or GRanges, or a list of such objects. The
5
+#'   table of regions must contain chr, start and end columns.
6
+#' @param groups if 'features' is a list, a vector of characters of the same
7
+#'   length as the list containing names for each member.
6 8
 #' @param flank the number of flanking bases to add to each side of each region.
9
+#' @param stranded TRUE if negative strand features should have coordinates
10
+#'   flipped to reflect features like transcription start sites.
7 11
 #' @param span the span for loess smoothing.
8 12
 #'
9 13
 #' @return a ggplot object.
... ...
@@ -109,10 +113,7 @@ plot_agg_regions <- function(
109 113
 
110 114
 #' Plot aggregate regions with grouped samples
111 115
 #'
112
-#' @param x the NanoMethResult object.
113
-#' @param regions a table of regions or GRanges.
114
-#' @param flank the number of flanking bases to add to each side of each region.
115
-#' @param span the span for loess smoothing.
116
+#' @inheritParams plot_agg_regions
116 117
 #'
117 118
 #' @return a ggplot plot object.
118 119
 #'