lunEstimate {splatter} | R Documentation

## Estimate Lun simulation parameters

### Description

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

### Usage

    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

    # Load example data
    library(scater)
    set.seed(1)
    sce <- mockSCE()

    params <- lunEstimate(sce)
    params

[Package splatter version 1.12.0 Index]