kersplatEstimate {splatter} | R Documentation

## Estimate Kersplat simulation parameters

### Description

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

### Usage

    kersplatEstimate(counts, params = newKersplatParams(), verbose = TRUE)

    ## S3 method for class 'SingleCellExperiment'
    kersplatEstimate(counts, params = newKersplatParams(), verbose = TRUE)

    ## S3 method for class 'matrix'
    kersplatEstimate(counts, params = newKersplatParams(), verbose = TRUE)

### Arguments

`counts` | either a counts matrix or a SingleCellExperiment object containing count data to estimate parameters from.
`params` | KersplatParams object to store estimated values in.
`verbose` | logical. Whether to print progress messages.

### Value

KersplatParams object containing the estimated parameters.

### See Also

`kersplatEstMean`, `kersplatEstBCV`, `kersplatEstLib`

### Examples

    if (requireNamespace("igraph", quietly = TRUE)) {
        # Load example data
        library(scater)
        set.seed(1)
        sce <- mockSCE()

        params <- kersplatEstimate(sce)
        params
    }

[Package splatter version 1.14.1 Index]