POWSC_estimation: Estimate Parameters From Real Datasets by POWSC

View source: R/09-POWSC.R

POWSC_estimationR Documentation

Estimate Parameters From Real Datasets by POWSC

Description

This function is used to estimate useful parameters from a real dataset by using Est2Phase function in POWSC package.

Usage

POWSC_estimation(ref_data, verbose = FALSE, other_prior = NULL, seed)

Arguments

ref_data

A count matrix. Each row represents a gene and each column represents a cell.

verbose

Logical.

other_prior

A list with names of certain parameters. Some methods need extra parameters to execute the estimation step, so you must input them. In simulation step, the number of cells, genes, groups, batches, the percent of DEGs and other variables are usually customed, so before simulating a dataset you must point it out.

seed

An integer of a random seed.

Details

When you use POWSC to estimate parameters from a real dataset, the default settings are recommended.

Value

A list contains the estimated parameters and the results of execution detection.

Examples

## Not run: 
ref_data <- SingleCellExperiment::counts(scater::mockSCE())

## estimation
estimate_result <- simmethods::POWSC_estimation(ref_data = ref_data,
                                                other_prior = NULL,
                                                verbose = TRUE,
                                                seed = 111)

## End(Not run)


duohongrui/simmethods documentation built on June 17, 2024, 10:49 a.m.