Params.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/params.R
\docType{class}
\name{Params}
\alias{Params}
\alias{Params-class}
\title{The Params virtual class}
\description{
Virtual S4 class that stores all parameters needed for the simulation of gene expression data.
}
\section{Parameters}{

The Params class defines the following parameters:
\describe{
    \item{\code{nGenes}}{A list containing the numbers of genes to simulate for
    each scenario and modality.}
    \item{\code{means}}{A list containing the parameter range for the mean for
    each scenario and modality.}
    \item{\code{foldChanges}}{A list containing the parameter range for the log2
    foldChanges between distributions for multimodal genes. Has to contain one
    entry less than the modality that is simulated.}
    \item{\code{sd}}{The parameters mu and lambda for the generation of the
    standard deviation of each distribution via an Inverse Gaussian distribution.}
    \item{\code{gamma}}{The shape and rate parameter  for generating the gamma
    distributions.}
    \item{\code{proportions}}{Parameters for the allowed proportions of
    multimodal distributions.}
    \item{\code{nPatients}}{The number of patients to simulate and how
    many columns the simulated gene expression should have per gene.}
    \item{\code{seed}}{Seed to use for generating random numbers.}
}
}