phenoEstimate: Estimate PhenoPath simulation parameters

Description Usage Arguments Details Value Examples

View source: R/pheno-estimate.R

Description

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

Usage

1
2
3
4
5
6
7
8
phenoEstimate(counts, params = newPhenoParams())

## S3 method for class 'SingleCellExperiment'
phenoEstimate(counts,
  params = newPhenoParams())

## S3 method for class 'matrix'
phenoEstimate(counts, params = newPhenoParams())

Arguments

counts

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

params

PhenoParams object to store estimated values in.

Details

The nGenes and nCells parameters are taken from the size of the input data. The total number of genes is evenly divided into the four types. See PhenoParams for more details on the parameters.

Value

PhenoParams object containing the estimated parameters.

Examples

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

params <- phenoEstimate(sc_example_counts)
params

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