EBSeq/man/IsoSimu.Rd

   1 \name{IsoSimu}
   2 \alias{IsoSimu}
   3 %- Also NEED an '\alias' for EACH other topic documented here.
   4 \title{
   5 Isoform level simulation
   6 }
   7 \description{
   8 Simulate isoform level expression data from a Negative Binomial assumption. (Without outliers)
   9 }
  10 \usage{
  11 IsoSimu(DVDconstant = NULL, DVDqt1 = NULL, DVDqt2 = NULL, Conditions, NumofSample, NumofIso = NULL, DEIsoProp, Phiconstant = NULL, Phi.qt1 = NULL, Phi.qt2 = NULL, NormFactor = NULL, OnlyData = T)
  12 }
  13 %- maybe also 'usage' for other objects documented here.
  14 \arguments{
  15   \item{DVDconstant}{
  16 Whether want to use constant fold change value for all the DE genes.
  17 }
  18   \item{DVDqt1, DVDqt2}{
  19 If DVDconstant is not specified, the user could use a range of empirical DVD's f
  20 rom Gould' data. The lower and upper bound ( quantile) could be specified.
  21 The suggested value is c(.96, .97). DVD for each gene will be randomly choosed within the range.
  22 }
  23   \item{Conditions}{
  24 A vector of charecters to show each sample's condition.
  25 (Only the two-condition case is supported now)
  26 }
  27   \item{NumofSample}{
  28 Number of samples the user want to generate.
  29 }
  30   \item{NumofIso}{
  31 Input should be a vector with length 3. All values should be non-negative.
  32 The ith value represents how many isoforms the user want to generate for isoform group i.
  33 }
  34   \item{DEIsoProp}{
  35 The proportion of isoforms to be generated as DE. The value should be in [0, 1].
  36 }
  37   \item{Phiconstant}{
  38 Whether set the disperse parameter phi to be a constant. If this parameter is specified, the settings of Phi.qt1 and Phi.qt2 will be ignored.
  39 Input should be a vector with length 3. The ith value indicates the overdisperse parameter of isoform group i.
  40 }
  41   \item{Phi.qt1, Phi.qt2}{
  42 If Phiconstant is not specified, the user could use a range of empirical phi's from each group of Gould' data. The lower and upper bound ( quantile) could be specified.
  43 The suggested value is c(.25, .75). phi for each gene will be randomly choosed w
  44 ithin the range.
  45
  46 }
  47   \item{NormFactor}{
  48 Wether set the mean of each isoform to be a constant.
  49 }
  50   \item{OnlyData}{
  51 Wether the user only want the generated data matrix. If OnlyData = T, the function will return the simulated matrix
  52 and the name of the DE genes.
  53 Otherwise the funtion will run DESeq, EBSeq, edgeR, baySeq and BBSeq and provide the results of each method.
  54 Currently only OnlyData=T is supported
  55 }
  56 }
  57 \details{
  58 For each isoform, we assumed that the expression follows a Negative Binomial distribution with mean mu_gi and variance mu_gi * (1 + mu_gi * phi_gi).
  59 For DE genes, we assumed that in one condition the genes are with mean mu_gi * DVD.
  60 mu, phi and DVD could be specified by the parameter settings.
  61
  62 }
  63 \value{
  64 \item{data}{
  65 A list of expression values will be generated.
  66 Each list represents a group of isoforms.
  67 Group1: Ng1
  68 Group2: Ng2
  69 Group3: Ng3
  70 The rows refer to the isoforms and the columns are the samples.
  71 The isoforms are named "I_GroupNumber_IsoformNumber". The first part of the isoforms of each group will be the DE ones. (The number depends on the DEIsoProp parameter.)
  72 }
  73 \item{TrueDE}{The names of the isoforms who are defined to be DE.}
  74
  75 }
  76 \references{
  77 %% ~put references to the literature/web site here ~
  78 }
  79 \author{
  80 Ning Leng
  81 }
  82 \note{
  83 %%  ~~further notes~~
  84 }
  85
  86 %% ~Make other sections like Warning with \section{Warning }{....} ~
  87
  88 \seealso{
  89 GeneSimu
  90 }
  91 \examples{
  92 ##---- Should be DIRECTLY executable !! ----
  93 ##-- ==>  Define data, use random,
  94 ##--    or do  help(data=index)  for the standard data sets.
  95 IsoGenerate=IsoSimu(DVDconstant=NULL, DVDqt1=.97, DVDqt2=.98, Conditions=as.factor(rep(c(1,2),each=5)), NumofSample=10, NumofIso=NULL, DEIsoProp=.1, Phiconstant=NULL, Phi.qt1=.25, Phi.qt2=.75, OnlyData=T )
  96
  97 }
  98 % Add one or more standard keywords, see file 'KEYWORDS' in the
  99 % R documentation directory.
 100 \keyword{ ~kwd1 }
 101 \keyword{ ~kwd2 }% __ONLY ONE__ keyword per line