File: nbinomLRT.Rd

package info (click to toggle)
r-bioc-deseq2 1.46.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,748 kB
  • sloc: cpp: 413; makefile: 2
file content (82 lines) | stat: -rw-r--r-- 2,694 bytes parent folder | download | duplicates (3)
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/core.R
\name{nbinomLRT}
\alias{nbinomLRT}
\title{Likelihood ratio test (chi-squared test) for GLMs}
\usage{
nbinomLRT(
  object,
  full = design(object),
  reduced,
  betaTol = 1e-08,
  maxit = 100,
  useOptim = TRUE,
  quiet = FALSE,
  useQR = TRUE,
  minmu = if (type == "glmGamPoi") 1e-06 else 0.5,
  type = c("DESeq2", "glmGamPoi")
)
}
\arguments{
\item{object}{a DESeqDataSet}

\item{full}{the full model formula, this should be the formula in
\code{design(object)}.
alternatively, can be a matrix}

\item{reduced}{a reduced formula to compare against, e.g.
the full model with a term or terms of interest removed.
alternatively, can be a matrix}

\item{betaTol}{control parameter defining convergence}

\item{maxit}{the maximum number of iterations to allow for convergence of the
coefficient vector}

\item{useOptim}{whether to use the native optim function on rows which do not
converge within maxit}

\item{quiet}{whether to print messages at each step}

\item{useQR}{whether to use the QR decomposition on the design
matrix X while fitting the GLM}

\item{minmu}{lower bound on the estimated count while fitting the GLM}

\item{type}{either "DESeq2" or "glmGamPoi". If \code{type = "DESeq2"} a
classical likelihood ratio test based on the Chi-squared distribution is
conducted. If \code{type = "glmGamPoi"} and previously the dispersion has
been estimated with glmGamPoi as well, a quasi-likelihood ratio test based
on the F-distribution is conducted. It is supposed to be more accurate, because
it takes the uncertainty of dispersion estimate into account in the same way
that a t-test improves upon a Z-test.}
}
\value{
a DESeqDataSet with new results columns accessible
with the \code{\link{results}} function.  The coefficients and standard errors are
reported on a log2 scale.
}
\description{
This function tests for significance of change in deviance between a
full and reduced model which are provided as \code{formula}.
Fitting uses previously calculated \code{\link{sizeFactors}} (or \code{\link{normalizationFactors}})
and dispersion estimates.
}
\details{
The difference in deviance is compared to a chi-squared distribution
with df = (reduced residual degrees of freedom - full residual degrees of freedom).
This function is comparable to the \code{nbinomGLMTest} of the previous version of DESeq
and an alternative to the default \code{\link{nbinomWaldTest}}.
}
\examples{

dds <- makeExampleDESeqDataSet()
dds <- estimateSizeFactors(dds)
dds <- estimateDispersions(dds)
dds <- nbinomLRT(dds, reduced = ~ 1)
res <- results(dds)

}
\seealso{
\code{\link{DESeq}}, \code{\link{nbinomWaldTest}}
}