Skip to content

Improve the description of peaksPerCell in the addReproduciblePeakSet function #14

@ycl6

Description

@ycl6

The description of the peaksPerCell param in the addReproduciblePeakSet function (for peak calling) is a bit misleading.

#' @param peaksPerCell The upper limit of the number of peaks that can be identified per cell-grouping in `groupBy`. This is useful
#' for controlling how many peaks can be called from cell groups with low cell numbers.
#' @param maxPeaks A numeric threshold for the maximum peaks to retain per group from `groupBy` in the union reproducible peak set.

Although the maintainer has answered what this param is GreenleafLab/ArchR#1082, but looking at the code, the peaksPerCell is still not a threshold to limit the number of peaks per cells, rather used to calculate maxPeaks for a cell group.

data.frame(
Group=names(coverageParams$cellGroups)[y],
nCells=tableGroups[names(coverageParams$cellGroups)[y]],
nCellsUsed=length(uniq),
nReplicates=length(x),
nMin=nmin,
nMax=nmax,
maxPeaks = min(maxPeaks, length(uniq) * peaksPerCell)
)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions