DESeq2Report: Generate a HTML/PDF report exploring DESeq2 results

View source: R/DESeq2Report.R

DESeq2ReportR Documentation

Generate a HTML/PDF report exploring DESeq2 results


This function generates a HTML report with exploratory data analysis plots for DESeq2 results created with DESeq. Other output formats are possible such as PDF but lose the interactivity. Users can easily append to the report by providing a R Markdown file to customCode, or can customize the entire template by providing an R Markdown file to template.


  project = "",
  colors = NULL,
  res = NULL,
  nBest = 500,
  nBestFeatures = 20,
  customCode = NULL,
  outdir = "DESeq2Exploration",
  output = "DESeq2Exploration",
  browse = interactive(),
  device = "png",
  template = NULL,
  searchURL = "",
  theme = NULL,
  digits = 2,



A DESeqDataSet object with the results from running DESeq.


The title of the project.


interesting groups: a character vector of names in colData(x) to use for grouping. This parameter is passed to functions such as plotPCA.


vector of colors used in heatmap. If NULL, then a a default set of colors will be used. This argument is passed to pheatmap.


A DESeqResults object. If NULL, then results will be used on dds with default parameters.


The number of features to include in the interactive table. Features are ordered by their adjusted p-values.


The number of best features to make plots of their counts. We recommend a small number, say 20.


An absolute path to a child R Markdown file with code to be evaluated before the reproducibility section. Its useful for users who want to customize the report by adding conclusions derived from the data and/or further quality checks and plots.


The name of output directory.


The name of output HTML file (without the html extension).


If TRUE the HTML report is opened in your browser once it's completed.


The graphical device used when knitting. See more at (dev argument).


Template file to use for the report. If not provided, will use the default file found in DESeq2Exploration/DESeq2Exploration.Rmd within the package source.


A url used for searching the name of the features in the web. By default is used which is the recommended option when features are genes. It's only used when the output is a HTML file.


A ggplot2 theme to use for the plots made with ggplot2.


The number of digits to round to in the interactive table of the top nBestFeatures. Note that p-values and adjusted p-values won't be rounded.


Arguments passed to other methods and/or advanced arguments. Advanced arguments:


The name of the package used for performing the differential expression analysis. Either DESeq2 or edgeR.


A DGEList object. NULL by default and only used by edgeReport.


The function call. NULL by default and only used by edgeReport.


Either html_document, pdf_document or knitrBootstrap::bootstrap_document unless you modify the YAML template.


Logical, whether to clean the results or not. Passed to render.


Set output_format to 'knitrBootstrap::bootstrap_document' or 'pdf_document' if you want a HTML report styled by knitrBootstrap or a PDF report respectively. If using knitrBootstrap, we recommend the version available only via GitHub at which has nicer features than the current version available via CRAN. You can also set the output_format to 'html_document' for a HTML report styled by rmarkdown. The default is set to 'BiocStyle::html_document'.

If you modify the YAML front matter of template, you can use other values for output_format.

The HTML report styled with knitrBootstrap can be smaller in size than the 'html_document' report.


An HTML report with a basic exploration for the given set of DESeq2 results. See an example at


Leonardo Collado-Torres


## Load example data from the pasilla package as done in the DESeq2 vignette
## at
## <>.
pasCts <- system.file("extdata",
    package = "pasilla", mustWork = TRUE
pasAnno <- system.file("extdata",
    package = "pasilla", mustWork = TRUE
cts <- as.matrix(read.csv(pasCts, sep = "\t", row.names = "gene_id"))
coldata <- read.csv(pasAnno, row.names = 1)
coldata <- coldata[, c("condition", "type")]
coldata$condition <- factor(coldata$condition)
coldata$type <- factor(coldata$type)
rownames(coldata) <- sub("fb", "", rownames(coldata))
cts <- cts[, rownames(coldata)]

## Create DESeqDataSet object from the pasilla package
dds <- DESeqDataSetFromMatrix(
    countData = cts,
    colData = coldata,
    design = ~condition
dds <- DESeq(dds)

## The output will be saved in the 'DESeq2Report-example' directory
dir.create("DESeq2Report-example", showWarnings = FALSE, recursive = TRUE)

## Generate the HTML report
report <- DESeq2Report(dds, "DESeq2-example", c("condition", "type"),
    outdir = "DESeq2Report-example"

if (interactive()) {
    ## Browse the report

## See the example output at
## Not run: 
## Note that you can run the example using:
example("DESeq2Report", "regionReport", ask = FALSE)

## End(Not run)

leekgroup/regionReport documentation built on May 10, 2023, 11:37 p.m.