scMultiSim_estimation: Estimate Parameters From Real Datasets by scMultiSim

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

Estimate Parameters From Real Datasets by scMultiSim

Description

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

Usage

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

Arguments

ref_data	A count matrix. Each row represents a gene and each column represents a cell.
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.
verbose	Logical.
seed	An integer of a random seed.

Details

In scMultiSim, users can input cell group information by other_prior = list(group.condition = xxx). If this information is not available, we will detect the potential groups in reference data automatically. For more information about scMultiSim, see Examples and References.

Value

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

References

Li H, Zhang Z, Squires M, et al. scMultiSim: simulation of multi-modality single cell data guided by cell-cell interactions and gene regulatory networks. bioRxiv, 2022: 2022.10. 15.512320. https://doi.org/10.1101/2022.10.15.512320

Github URL: https://github.com/ZhangLabGT/scMultiSim

Examples

## Not run: 
ref_data <- simmethods::data
## estimation
estimate_result <- simmethods::scMultiSim_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.