File: computeSumFactors.R

package info (click to toggle)
r-bioc-scran 1.26.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,692 kB
  • sloc: cpp: 733; makefile: 2
file content (26 lines) | stat: -rw-r--r-- 964 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#' Normalization by deconvolution
#'
#' Scaling normalization of single-cell RNA-seq data by deconvolving size factors from cell pools.
#' These functions have been moved to the \pkg{scuttle} package and are just retained here for compatibility.
#'
#' @param ... Further arguments to pass to \code{\link{pooledSizeFactors}} or \code{\link{computePooledFactors}}.
#'
#' @return
#' For \code{calculateSumFactors}, a numeric vector of size factors returned by \code{\link{pooledSizeFactors}}.
#'
#' For \code{computeSumFactors}, a SingleCellExperiment containing the size factors in its \code{\link{sizeFactors}},
#' as returned by \code{\link{computePooledFactors}}.
#'
#' @author Aaron Lun
#' @export
#' @importFrom scuttle computePooledFactors
computeSumFactors <- function(...) {
    computePooledFactors(...)
}

#' @export
#' @importFrom scuttle pooledSizeFactors
#' @rdname computeSumFactors 
calculateSumFactors <- function(...) {
    pooledSizeFactors(...)
}