zingeR_estimation: Estimate Parameters From Real Datasets by zingeR

In duohongrui/simmethods: A collection of 40+ simulation methods for singlce-cell RNA seqencing data

Estimate Parameters From Real Datasets by zingeR

Description

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

Usage

zingeR_estimation(ref_data, verbose = FALSE, other_prior, 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 are usually customed, so before simulating a dataset you must point it out. See Details below for more information.
seed	An integer of a random seed.

Details

When you use zingeR to estimate parameters from a real dataset, you must input a numeric vector to specify the groups that each cell belongs to, like ⁠other_prior = list(group.condition = the numeric vector)⁠. See Examples and learn from it.

Value

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

References

Github URL: https://github.com/statOmics/zingeR

Examples

## Not run: 
ref_data <- simmethods::data
group_condition <- as.numeric(simmethods::group_condition)

estimate_result <- simmethods::zingeR_estimation(
  ref_data = ref_data,
  other_prior = list(group.condition = group_condition),
  verbose = TRUE,
  seed = 111
)

## End(Not run)

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