regionReport

Generate HTML reports for a set of regions such as those from derfinder results.

Check the documentation for derfinderReport() for an example on how to create the necessary input files and generating the HTML report for derfinder results. Or use:

example('derfinderReport', 'regionReport', ask=FALSE)

You may also want to consult the vignette for regionReport.

Installation instructions

Get R 3.1.1 or newer from CRAN as well as pandoc 1.12.3 or newer from here.

## From Bioconductor
source('http://bioconductor.org/biocLite.R')
biocLite('regionReport')

Vignette

The vignette for this package can be viewed here or via Bioconductor's website.

Citation

Below is the citation output from using citation('regionReport')[1] in R. Please run this yourself to check for any updates on how to cite regionReport.

To cite package regionReport in publications use:

Collado-Torres L, Jaffe AE and Leek JT (2015). regionReport: Generate HTML reports for exploring a set of regions. https://github.com/lcolladotor/regionReport - R package version 1.1.7, <URL: http://www.bioconductor.org/packages/release/bioc/html/regionReport.html>.

A BibTeX entry for LaTeX users is

@Manual{, title = {regionReport: Generate HTML reports for exploring a set of regions}, author = {Leonardo Collado-Torres and Andrew E. Jaffe and Jeffrey T. Leek}, year = {2015}, url = {http://www.bioconductor.org/packages/release/bioc/html/regionReport.html}, note = {https://github.com/lcolladotor/regionReport - R package version 1.0.5}, }

Travis CI

This package is automatically tested thanks to Travis CI and r-travis. If you want to add this to your own package use:

## Use devtools to create the .travis.yml file
library('devtools')
use_travis('yourPackage')

## Read https://github.com/craigcitro/r-travis/wiki to configure .travis.yml appropriately

## Add a status image by following the info at http://docs.travis-ci.com/user/status-images/

Testing on R-devel for Bioc-devel is feasible thanks to r-builder.