Note: the most recent version of this vignette can be found here and a short overview slide show here.
systemPipeRdata is a helper package to generate with a single command NGS workflow templates that are intended to be used by its parent package systemPipeR (Girke 2014). The latter is an environment for building end-to-end analysis pipelines with automated report generation for next generation sequence (NGS) applications such as RNA-Seq, Ribo-Seq, ChIP-Seq, VAR-Seq and many others. The directory structure of the workflow templates and the sample data used by systemPipeRdata are described here.
systemPipeRdata can be downloaded from CRAN. The systemPipeRdata package can be installed from within R as follows:
zR`{r install, eval=FALSE}
if (!requireNamespace(“BiocManager”, quietly=TRUE))
install.packages(“BiocManager”)
BiocManager::install(“tgirke/systemPipeRdata”, build_vignettes=TRUE, dependencies=TRUE) # Installs from github
BiocManager::install(“systemPipeRdata”) # Installs from Bioconductor once available there
```
library("systemPipeRdata") # Loads the packagelibrary(help="systemPipeRdata") # Lists package info
vignette("systemPipeRdata") # Opens vignetteLoad one of the available NGS workflows into your current working directory. The following does this for the varseq template. The name of the resulting workflow directory can be specified under the mydirname argument. The default NULL uses the name of the chosen workflow. An error is issued if a directory of the same name and path exists already.
genWorkenvir(workflow="varseq", mydirname=NULL)
setwd("varseq")On Linux and OS X systems the same can be achieved from the command-line of a terminal with the following commands.
{.sh generate_workenvir_from_shell, eval=FALSE} $ Rscript -e "systemPipeRdata::genWorkenvir(workflow='varseq', mydirname=NULL)"
The workflow templates generated by genWorkenvir contain the following preconfigured directory structure:
workflow_name/ # *.Rnw/*.Rmd scripts and targets file
param/ # parameter files for command-line software
data/ # inputs e.g. FASTQ, reference, annotations
results/ # analysis result filesNext, run from within R the chosen sample workflow by executing the code provided in the corresponding *.Rnw template file. If preferred the corresponding *.Rmd or *.R versions can be used instead. Alternatively, one can run an entire workflow from start to finish with a single command by executing from the command-line 'make -B' within the workflow directory (here 'varseq'). Much more detailed information on running and customizing systemPipeR workflows is available in its overview vignette here. This vignette can also be opened from R with the following command.
library("systemPipeR") # Loads systemPipeR which needs to be installed via BiocManager::install() from Bioconductorvignette("systemPipeR", package = "systemPipeR")The location of the sample data provided by systemPipeRdata can be returned as a list.
pathList()## $targets
## [1] "/tmp/RtmpV5x46p/Rinst6b2941d1e232/systemPipeRdata/extdata/param/targets.txt"
##
## $targetsPE
## [1] "/tmp/RtmpV5x46p/Rinst6b2941d1e232/systemPipeRdata/extdata/param/targetsPE.txt"
##
## $annotationdir
## [1] "/tmp/RtmpV5x46p/Rinst6b2941d1e232/systemPipeRdata/extdata/annotation/"
##
## $fastqdir
## [1] "/tmp/RtmpV5x46p/Rinst6b2941d1e232/systemPipeRdata/extdata/fastq/"
##
## $bamdir
## [1] "/tmp/RtmpV5x46p/Rinst6b2941d1e232/systemPipeRdata/extdata/bam/"
##
## $paramdir
## [1] "/tmp/RtmpV5x46p/Rinst6b2941d1e232/systemPipeRdata/extdata/param/"
##
## $workflows
## [1] "/tmp/RtmpV5x46p/Rinst6b2941d1e232/systemPipeRdata/extdata/workflows/"
##
## $chipseq
## [1] "/tmp/RtmpV5x46p/Rinst6b2941d1e232/systemPipeRdata/extdata/workflows/chipseq/"
##
## $rnaseq
## [1] "/tmp/RtmpV5x46p/Rinst6b2941d1e232/systemPipeRdata/extdata/workflows/rnaseq/"
##
## $riboseq
## [1] "/tmp/RtmpV5x46p/Rinst6b2941d1e232/systemPipeRdata/extdata/workflows/riboseq/"
##
## $varseq
## [1] "/tmp/RtmpV5x46p/Rinst6b2941d1e232/systemPipeRdata/extdata/workflows/varseq/"sessionInfo()## R version 3.5.1 Patched (2018-07-12 r74967)
## Platform: x86_64-pc-linux-gnu (64-bit)
## Running under: Ubuntu 16.04.5 LTS
##
## Matrix products: default
## BLAS: /home/biocbuild/bbs-3.8-bioc/R/lib/libRblas.so
## LAPACK: /home/biocbuild/bbs-3.8-bioc/R/lib/libRlapack.so
##
## locale:
## [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C LC_TIME=en_US.UTF-8
## [4] LC_COLLATE=C LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
## [7] LC_PAPER=en_US.UTF-8 LC_NAME=C LC_ADDRESS=C
## [10] LC_TELEPHONE=C LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
##
## attached base packages:
## [1] stats4 parallel stats graphics grDevices utils datasets methods base
##
## other attached packages:
## [1] systemPipeRdata_1.10.0 systemPipeR_1.16.0 ShortRead_1.40.0
## [4] GenomicAlignments_1.18.0 SummarizedExperiment_1.12.0 DelayedArray_0.8.0
## [7] matrixStats_0.54.0 Biobase_2.42.0 BiocParallel_1.16.0
## [10] Rsamtools_1.34.0 Biostrings_2.50.0 XVector_0.22.0
## [13] GenomicRanges_1.34.0 GenomeInfoDb_1.18.0 IRanges_2.16.0
## [16] S4Vectors_0.20.0 BiocGenerics_0.28.0 BiocStyle_2.10.0
##
## loaded via a namespace (and not attached):
## [1] Category_2.48.0 bitops_1.0-6 bit64_0.9-7 RColorBrewer_1.1-2
## [5] progress_1.2.0 httr_1.3.1 rprojroot_1.3-2 Rgraphviz_2.26.0
## [9] tools_3.5.1 backports_1.1.2 R6_2.3.0 DBI_1.0.0
## [13] lazyeval_0.2.1 colorspace_1.3-2 tidyselect_0.2.5 prettyunits_1.0.2
## [17] bit_1.1-14 compiler_3.5.1 sendmailR_1.2-1 graph_1.60.0
## [21] rtracklayer_1.42.0 bookdown_0.7 checkmate_1.8.5 scales_1.0.0
## [25] BatchJobs_1.7 genefilter_1.64.0 RBGL_1.58.0 stringr_1.3.1
## [29] digest_0.6.18 rmarkdown_1.10 AnnotationForge_1.24.0 base64enc_0.1-3
## [33] pkgconfig_2.0.2 htmltools_0.3.6 limma_3.38.0 rlang_0.3.0.1
## [37] RSQLite_2.1.1 BBmisc_1.11 bindr_0.1.1 GOstats_2.48.0
## [41] hwriter_1.3.2 dplyr_0.7.7 RCurl_1.95-4.11 magrittr_1.5
## [45] GO.db_3.7.0 GenomeInfoDbData_1.2.0 Matrix_1.2-14 Rcpp_0.12.19
## [49] munsell_0.5.0 stringi_1.2.4 yaml_2.2.0 edgeR_3.24.0
## [53] zlibbioc_1.28.0 plyr_1.8.4 grid_3.5.1 blob_1.1.1
## [57] crayon_1.3.4 lattice_0.20-35 splines_3.5.1 GenomicFeatures_1.34.0
## [61] annotate_1.60.0 hms_0.4.2 locfit_1.5-9.1 knitr_1.20
## [65] pillar_1.3.0 rjson_0.2.20 codetools_0.2-15 biomaRt_2.38.0
## [69] XML_3.98-1.16 glue_1.3.0 evaluate_0.12 latticeExtra_0.6-28
## [73] data.table_1.11.8 BiocManager_1.30.3 gtable_0.2.0 purrr_0.2.5
## [77] assertthat_0.2.0 ggplot2_3.1.0 xfun_0.4 xtable_1.8-3
## [81] survival_2.43-1 pheatmap_1.0.10 tibble_1.4.2 AnnotationDbi_1.44.0
## [85] memoise_1.1.0 bindrcpp_0.2.2 brew_1.0-6 GSEABase_1.44.0This project was supported by funds from the National Institutes of Health (NIH) and the National Science Foundation (NSF).
Girke, Thomas. 2014. “systemPipeR: NGS Workflow and Report Generation Environment.” UC Riverside. https://github.com/tgirke/systemPipeR.