SCDDParams.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/AllClasses.R
\docType{class}
\name{SCDDParams}
\alias{SCDDParams}
\alias{SCDDParams-class}
\title{The SCDDParams class}
\description{
S4 class that holds parameters for the scDD simulation.
}
\section{Parameters}{


The SCDD simulation uses the following parameters:

\describe{
    \item{\code{[nGenes]}}{The number of genes to simulate (not used).}
    \item{\code{nCells}}{The number of cells to simulate in each condition.}
    \item{\code{[seed]}}{Seed to use for generating random numbers.}
    \item{\code{SCdat}}{\code{\link{ExpressionSet}} containing real data.}
    \item{\code{[nDE]}}{Number of DE genes to simulate.}
    \item{\code{[nDP]}}{Number of DP genes to simulate.}
    \item{\code{[nDM]}}{Number of DM genes to simulate.}
    \item{\code{[nDB]}}{Number of DB genes to simulate.}
    \item{\code{[nEE]}}{Number of EE genes to simulate.}
    \item{\code{[nEP]}}{Number of EP genes to simulate.}
    \item{\code{[sd.range]}}{Interval for fold change standard deviations.}
    \item{\code{[modeFC]}}{Values for DP, DM and DB mode fold changes.}
    \item{\code{[varInflation}]}{Variance inflation factors for each
    condition.}
}

The parameters not shown in brackets can be estimated from real data using
\code{\link{scDDEstimate}}. See \code{\link[scDD]{simulateSet}} for more
details of the parameters. For details of the Splatter implementation of the
scDD simulation see \code{\link{scDDSimulate}}.
}