File: estimateHyperPar.Rd

package info (click to toggle)
r-bioc-bitseq 1.26.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 5,620 kB
  • sloc: cpp: 6,506; sh: 4; makefile: 2
file content (51 lines) | stat: -rw-r--r-- 3,134 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
\name{estimateHyperPar}
\alias{estimateHyperPar}
\title{Estimate hyperparameters for DE model using expression samples and joint mean expression}
\description{Estimate hyperparameters for the Differential Expression model using expression samples and produced smoothed values of the hyperparameters depending on joint mean expression.}
\usage{
estimateHyperPar( outFile, conditions=NULL, paramsInFile=NULL, 
      meanFile=NULL, force=TRUE, exThreshold=NULL, lambda0=NULL, 
      paramsAllFile=NULL, smoothOnly=NULL, lowess_f=NULL, lowess_steps=NULL,
      verbose=NULL, veryVerbose=NULL, norm=NULL, seed=NULL, pretend=FALSE )
}
\arguments{
\item{outFile}{Name of the output file.}
\item{conditions}{\code{List} of vectors, each vector containing names of files containing the expression samples from a replicate (Can be both technical and biological replicates. However, in order to get good results biological replicates for each condition are essential).}
\item{paramsInFile}{File produced by previous run of the function using \code{paramsAllFile} flag.}
\item{meanFile}{Name of the file containing joint mean and variance.}
\item{exThreshold}{Threshold of lowest expression for which the estimation is done.}
\item{paramsAllFile}{Name of the file to which to store all parameter values generated prior to lowess smoothing(good for later, more careful re-smoothing.)}
\item{smoothOnly}{Input file contains previously sampled hyperparameters which should smoothed only.}
\item{verbose}{Verbose output.}
Advanced options:
\item{force}{Force smoothing hyperparameters, otherwise program might not produce parameters file at the end.}
\item{lambda0}{Model parameter lambda0.}
\item{lowess_f}{Parameter F for lowess smoothing specifying amount of smoothing.}
\item{lowess_steps}{Parameter Nsteps for lowess smoothing specifying number of iterations.}
\item{veryVerbose}{More verbose output.}
\item{norm}{Vector of (multiplicative) normalization constants for library size normalization of expression samples. Number of constants has to match the number of expression samples files.} 
\item{seed}{Sets the initial random seed for repeatable experiments.}
\item{pretend}{Do not execute, only print out command line calls for the C++ version of the program.}
%\item{groupsNumber}{Number of groups of transcript of similar size.}
%\item{samplesNumber}{Number of samples generated for each group.}
}
%\details{}
\value{
\item{.par}{file containing the smoothed hyperparameters}
\item{.ALLpar}{file containing all hyperparameter samples prior to smoothing - optional}
}
\author{Peter Glaus}

\seealso{\code{\link{estimateDE}}}
\examples{\dontrun{
cond1Files = c("data-c0b0.rpkm","data-c0b1.rpkm")
cond2Files = c("data-c1b0.rpkm","data-c1b1.rpkm")
estimateHyperPar( conditions=list(cond1Files, cond2Files), outFile="data.par", 
      meanFile="data.means", verbose=TRUE)

estimateHyperPar( conditions=list(cond1Files, cond2Files), outFile="data.par", 
      meanFile="data.means", paramsFile="data.ALLpar", force=FALSE)
estimateHyperPar( outFile="data.par", paramsInFile="data.ALLpar", smoothOnly=TRUE )
}}

\keyword{differential expression}