lunEstimate: Estimate Lun simulation parameters

Description Usage Arguments Details Value Examples

View source: R/lun-estimate.R

Description

Estimate simulation parameters for the Lun simulation from a real dataset.

Usage

1
2
3
4
5
6
7
8
lunEstimate(counts, params = newLunParams())

## S3 method for class 'SingleCellExperiment'
lunEstimate(counts,
  params = newLunParams())

## S3 method for class 'matrix'
lunEstimate(counts, params = newLunParams())

Arguments

counts

either a counts matrix or an SingleCellExperiment object containing count data to estimate parameters from.

params

LunParams object to store estimated values in.

Details

The nGenes and nCells parameters are taken from the size of the input data. No other parameters are estimated. See LunParams for more details on the parameters.

Value

LunParams object containing the estimated parameters.

Examples

1
2
3
4
5
6
# Load example data
library(scater)
data("sc_example_counts")

params <- lunEstimate(sc_example_counts)
params

splatter documentation built on Dec. 7, 2018, 6 p.m.