Browse code

example explanation for enrichment: combinations

ataudt authored on 15/12/2021 02:44:02
Showing 2 changed files

... ...
@@ -3,7 +3,7 @@
3 3
 #' Plotting functions for enrichment analysis of \code{\link{multiHMM}} or \code{\link{combinedMultiHMM}} objects with any annotation of interest, specified as a \code{\link[GenomicRanges]{GRanges-class}} object.
4 4
 #' 
5 5
 #' @name enrichment_analysis
6
-#' @param combinations A vector with combinations for which the enrichment will be calculated. If \code{NULL} all combinations will be considered.
6
+#' @param combinations A vector with combinations for which the enrichment will be calculated, e.g. \code{combinations = c('[H3K4me3]','[H3K4me3+H3K27me3]')}. If \code{NULL} all combinations will be considered.
7 7
 #' @param marks A vector with marks for which the enrichment is plotted. If \code{NULL} all marks will be considered.
8 8
 #' @param logscale Set to \code{TRUE} to plot fold enrichment on log-scale. Ignored if \code{statistic = 'fraction'}.
9 9
 #' @return A \code{\link[ggplot2:ggplot]{ggplot}} object containing the plot or a list() with \code{\link[ggplot2:ggplot]{ggplot}} objects if several plots are returned. For \code{plotFoldEnrichHeatmap} a named array with fold enrichments if \code{plot=FALSE}.
... ...
@@ -48,7 +48,7 @@ plotEnrichment(
48 48
 
49 49
 \item{what}{One of \code{c('combinations','peaks','counts','transitions')} specifying on which feature the statistic is calculated.}
50 50
 
51
-\item{combinations}{A vector with combinations for which the enrichment will be calculated. If \code{NULL} all combinations will be considered.}
51
+\item{combinations}{A vector with combinations for which the enrichment will be calculated, e.g. \code{combinations = c('[H3K4me3]','[H3K4me3+H3K27me3]')}. If \code{NULL} all combinations will be considered.}
52 52
 
53 53
 \item{marks}{A vector with marks for which the enrichment is plotted. If \code{NULL} all marks will be considered.}
54 54