Name Mode Size
R 040000
inst 040000
man 040000
tests 040000
vignettes 040000
DESCRIPTION 100644 2 kb
NAMESPACE 100644 1 kb
NEWS 100644 3 kb
README 100644 3 kb
README.md 100644 3 kb
README.md
### systemPipeR: NGS workflow and report generation environment [_systemPipeR_](http://www.bioconductor.org/packages/devel/bioc/html/systemPipeR.html) is an R/Bioconductor package for building and running automated *end-to-end* analysis workflows for a wide range of next generation sequence (NGS) applications such as RNA-Seq, ChIP-Seq, VAR-Seq and Ribo-Seq. Important features include a uniform workflow interface across different NGS applications, automated report generation, and support for running both R and command-line software, such as NGS aligners or peak/variant callers, on local computers or compute clusters. The latter supports interactive job submissions and batch submissions to queuing systems of clusters. Efficient handling of complex sample sets and experimental designs is facilitated by a well-defined sample annotation infrastructure which improves reproducibility and user-friendliness of many typical analysis workflows in the NGS area. #### Installation To install the package, please use the _biocLite_ method as instructed [_here_](http://www.bioconductor.org/packages/devel/bioc/html/systemPipeR.html). To obtain the most recent updates immediately, one can install it directly from github as follows: ```s source("http://bioconductor.org/biocLite.R") biocLite("tgirke/systemPipeR", build_vignettes=TRUE, dependencies=TRUE) ``` #### Usage Instructions for running _systemPipeR_ are given in its main [_vignette_](https://htmlpreview.github.io/?https://github.com/tgirke/systemPipeR/blob/master/vignettes/systemPipeR.html) (manual). The sample data set used in the vignette are provided by the data package [_systemPipeRdata_](https://github.com/tgirke/systemPipeRdata). The expected format to define NGS samples (_e.g._ FASTQ files) and their labels are given in [_targets.txt_](https://github.com/tgirke/systemPipeR/blob/master/inst/extdata/targets.txt) and [_targetsPE.txt_](https://github.com/tgirke/systemPipeR/blob/master/inst/extdata/targetsPE.txt) (latter is for PE reads). The run parameters of command-line software are defined by param files that have a simplified JSON-like name/value structure. Here is a sample param file for _Tophat2_: [_tophat.param_](https://github.com/tgirke/systemPipeR/blob/master/inst/extdata/tophat.param). Templates for setting up custom project reports are provided by [_systemPipeRdata_](https://github.com/tgirke/systemPipeRdata). The corresponding PDFs of these report templates are linked here: [systemPipeRNAseq](https://github.com/tgirke/systemPipeR/blob/master/vignettes/systemPipeRNAseq.pdf?raw=true), [systemPipeRIBOseq](https://github.com/tgirke/systemPipeR/blob/master/vignettes/systemPipeRIBOseq.pdf?raw=true), [systemPipeChIPseq](https://github.com/tgirke/systemPipeR/blob/master/vignettes/systemPipeChIPseq.pdf?raw=true) and [systemPipeVARseq](https://github.com/tgirke/systemPipeR/blob/master/vignettes/systemPipeVARseq.pdf?raw=true). #### Slides + [Overview Slide Show](https://htmlpreview.github.io/?https://raw.githubusercontent.com/tgirke/systemPipeR/master/inst/extdata/slides/systemPipeRslides.html)