Skip to content

Commit b5df9d0

Browse files
committed
update documentation
1 parent d3970a8 commit b5df9d0

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

R/methSeg.R

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,16 @@
4949
#' @details
5050
#' To be sure that the algorithm will work on your data,
5151
#' the object should have at least 5000 records
52+
#'
53+
#' @details After initial segmentation with fastseg(), segments are clustered
54+
#' into self-similar groups based on their mean methylation profile
55+
#' using mixture modeling. Mixture modeling estimates the initial
56+
#' parameters of the distributions by using the whole dataset.
57+
#' If "initialize.on.subset" argument set as described, the function
58+
#' will use a subset of the data to initialize the parameters of the
59+
#' mixture modeling prior to the Expectation-maximization (EM) algorithm
60+
#' used by \code{\link{Mclust}} package.
61+
#'
5262
#' @examples
5363
#'
5464
#' \donttest{

man/methSeg.Rd

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)