renderReport {regionReport} | R Documentation

## Generate a HTML/PDF report exploring a set of genomic regions

### Description

This function generates a HTML report with quality checks, genome location exploration, and an interactive table with the results. 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`.

### Usage

    renderReport(regions, project = "", pvalueVars = c(`P-values` = "pval"),
      densityVars = NULL, significantVar = mcols(regions)$pval <= 0.05,
      annotation = NULL, nBestRegions = 500, customCode = NULL,
      outdir = "regionExploration", output = "regionExploration",
      browse = interactive(), txdb = NULL, device = "png",
      densityTemplates = list(Pvalue = templatePvalueDensity, Common =
      templateDensity, Manhattan = templateManhattan), template = NULL,
      theme = NULL, digits = 2, ...)

    templatePvalueDensity

    templateDensity

    templateManhattan

    templatePvalueHistogram

    templateHistogram

### Arguments

`regions` | The set of genomic regions of interest as a `GRanges` object. All sequence lengths must be provided.
`project` | The title of the project.
`pvalueVars` | The names of the variables with values between 0 and 1 to plot density values by chromosome and a table for commonly used cutoffs. Most commonly used to explore p-value distributions. If a named character vector is provided, the names are used in the plot titles.
`densityVars` | The names of variables to use for making density plots by chromosome. Commonly used to explore scores and other variables given by region. If a named character vector is provided, the names are used in the plot titles.
`significantVar` | A `logical` variable differentiating statistically significant regions from the rest. When provided, both types of regions are compared against each other to see differences in width, location, etc.
`annotation` | The output from matchGenes used on `regions`. Note that this can take time for a large set of regions so it's better to pre-compute this information and save it.
`nBestRegions` | The number of regions to include in the interactive table.
`customCode` | 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.
`outdir` | The name of output directory.
`output` | The name of output HTML file (without the html extension).
`browse` | If `TRUE` the HTML report is opened in your browser once it's completed.
`txdb` | Specify the transcription database to use for identifying the closest genes via matchGenes. If `NULL` it will use TxDb.Hsapiens.UCSC.hg19.knownGene by default.
`device` | The graphical device used when knitting. See more at http://yihui.name/knitr/options (`dev` argument).
`densityTemplates` | A list of length 3 with templates for the p-value density plots (variables from `pvalueVars`), the continuous variables density plots (variables from `densityVars`), and Manhattan plots for the p-value variables (`pvalueVars`). These templates are processed by whisker.render. Check the default templates for more information. The `densityTemplates` argument is available for those users interested in customizing these plots. For example, to show histograms instead of density plots use `templatePvalueHistogram` and `templateHistogram` instead of `templatePvalueDensity` and `templateDensity` respectively.
`template` | Template file to use for the report. If not provided, will use the default file found in regionExploration/regionExploration.Rmd within the package source.
`theme` | A ggplot2 theme to use for the plots made with ggplot2.
`digits` | The number of digits to round to in the interactive table of the top `nBestRegions`. Note that p-values and adjusted p-values won't be rounded.
`...` | Arguments passed to other methods and/or advanced arguments. Advanced arguments: overviewParams A two element list with `base_size` and `areaRel` that control the text size for the genomic overview plots. output_format Either `html_document`, `pdf_document` or `knitrBootstrap::bootstrap_document` unless you modify the YAML template. clean Logical, whether to clean the results or not. Passed to render.

### Format

An object of class `character` of length 1.

### Details

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 https://github.com/jimhester/knitrBootstrap 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.

### Value

An HTML report with a basic exploration for the given set of genomic regions.

### Author(s)

Leonardo Collado-Torres

### Examples

    ## Load derfinder for an example set of regions
    library('derfinder')
    regions <- genomeRegions$regions

    ## Assign chr length
    library('GenomicRanges')
    seqlengths(regions) <- c('chr21' = 48129895)

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

    ## Generate the HTML report
    report <- renderReport(regions, 'Example run', pvalueVars = c(
        'Q-values' = 'qvalues', 'P-values' = 'pvalues'), densityVars = c(
        'Area' = 'area', 'Mean coverage' = 'meanCoverage'),
        significantVar = regions$qvalues <= 0.05, nBestRegions = 20,
        outdir = 'renderReport-example')

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

    ## Not run:
    ## Note that you can run the example using:
    example('renderReport', 'regionReport', ask=FALSE)

    ## End(Not run)

    ## Check the default templates. For users interested in customizing these
    ## plots.
    ## For p-value variables:
    cat(templatePvalueDensity)

    ## For continous variables:
    cat(templateDensity)

    ## For Manhattan plots
    cat(templateManhattan)

[Package regionReport version 1.12.2 Index]