splatEstimate {splatter} | R Documentation

## Estimate Splat simulation parameters

### Description

Estimate simulation parameters for the Splat simulation from a real dataset. See the individual estimation functions for more details on how this is done.

### Usage

    splatEstimate(counts, params = newSplatParams())

    ## S3 method for class 'SingleCellExperiment'
    splatEstimate(counts,
      params = newSplatParams())

    ## S3 method for class 'matrix'
    splatEstimate(counts, params = newSplatParams())

### Arguments

`counts` | either a counts matrix or a SingleCellExperiment object containing count data to estimate parameters from.
`params` | SplatParams object to store estimated values in.

### Value

SplatParams object containing the estimated parameters.

### See Also

`splatEstMean`, `splatEstLib`, `splatEstOutlier`, `splatEstBCV`, `splatEstDropout`

### Examples

    # Load example data
    library(scater)
    data("sc_example_counts")

    params <- splatEstimate(sc_example_counts)
    params

[Package splatter version 1.6.1 Index]