simulateDGE.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/simulate.R
\name{simulateDGE}
\alias{simulateDGE}
\title{Simulate Single Cell RNAseq count data}
\usage{
simulateDGE(parameters, sparse = TRUE, cell_prefix = "cell", dge = TRUE,
  seed = NULL)
}
\arguments{
\item{parameters}{object of class dropsim containing parameters}

\item{sparse}{logical; if true the counts are returned as a sparse matrix}

\item{cell_prefix}{character; the default group name for cells}

\item{dge}{logical; if false counts a returned as a matrix cells by genes rather than genes by cells
(If sparse=FALSE, setting dge=FALSE can save time on larger datasets.)}

\item{seed}{integer; seed for random number generation, set this for repoduciable simulations.}
}
\value{
A list containing a matrix of read counts, true underlying expression values,
fold change in expression for the groups simulated, and the seed used for random number generation.
}
\description{
\code{simulateDGE} simulate digital gene expression matrix containing count data from given parameters
}
\examples{
# new_parameters <- dropsim_parameters()
# dge <- simulate(new_parameters)
}