systemPipeR

This is the released version of systemPipeR; for the devel version, see systemPipeR.

systemPipeR: Workflow Environment for Data Analysis and Report Generation


Bioconductor version: Release (3.20)

systemPipeR is a multipurpose data analysis workflow environment that unifies R with command-line tools. It enables scientists to analyze many types of large- or small-scale data on local or distributed computer systems with a high level of reproducibility, scalability and portability. At its core is a command-line interface (CLI) that adopts the Common Workflow Language (CWL). This design allows users to choose for each analysis step the optimal R or command-line software. It supports both end-to-end and partial execution of workflows with built-in restart functionalities. Efficient management of complex analysis tasks is accomplished by a flexible workflow control container class. Handling of large numbers of input samples and experimental designs is facilitated by consistent sample annotation mechanisms. As a multi-purpose workflow toolkit, systemPipeR enables users to run existing workflows, customize them or design entirely new ones while taking advantage of widely adopted data structures within the Bioconductor ecosystem. Another important core functionality is the generation of reproducible scientific analysis and technical reports. For result interpretation, systemPipeR offers a wide range of plotting functionality, while an associated Shiny App offers many useful functionalities for interactive result exploration. The vignettes linked from this page include (1) a general introduction, (2) a description of technical details, and (3) a collection of workflow templates.

Author: Thomas Girke

Maintainer: Thomas Girke <thomas.girke at ucr.edu>

Citation (from within R, enter citation("systemPipeR")):

Installation

To install this package, start R (version "4.4") and enter:


if (!require("BiocManager", quietly = TRUE))
    install.packages("BiocManager")

BiocManager::install("systemPipeR")

For older versions of R, please refer to the appropriate Bioconductor release.

Documentation

To view documentation for the version of this package installed in your system, start R and enter:

browseVignettes("systemPipeR")
Overview HTML R Script
systemPipeR: Workflow Templates HTML R Script
Reference Manual PDF
NEWS Text

Details

biocViews Alignment, ChIPSeq, Coverage, DataImport, GeneExpression, GeneSetEnrichment, Genetics, ImmunoOncology, Infrastructure, MethylSeq, QualityControl, RNASeq, ReportWriting, RiboSeq, SNP, Sequencing, Software, WorkflowManagement, WorkflowStep
Version 2.12.0
In Bioconductor since BioC 3.0 (R-3.1) (10 years)
License Artistic-2.0
Depends Rsamtools(>= 1.31.2), Biostrings, ShortRead(>= 1.37.1), methods
Imports GenomicRanges, SummarizedExperiment, ggplot2, yaml, stringr, magrittr, S4Vectors, crayon, BiocGenerics, htmlwidgets
System Requirements systemPipeR can be used to run external command-line software (e.g. short read aligners), but the corresponding tool needs to be installed on a system.
URL https://systempipe.org/ https://github.com/tgirke/systemPipeR
See More
Suggests BiocStyle, knitr, rmarkdown, systemPipeRdata, GenomicAlignments, grid, dplyr, testthat, rjson, annotate, AnnotationDbi, kableExtra, GO.db, GenomeInfoDb, DT, rtracklayer, limma, edgeR, DESeq2, IRanges, batchtools, GenomicFeatures, txdbmaker, VariantAnnotation(>= 1.25.11)
Linking To
Enhances
Depends On Me
Imports Me DiffBind
Suggests Me systemPipeShiny, systemPipeTools, systemPipeRdata
Links To Me
Build Report Build Report

Package Archives

Follow Installation instructions to use this package in your R session.

Source Package systemPipeR_2.12.0.tar.gz
Windows Binary (x86_64) systemPipeR_2.12.0.zip
macOS Binary (x86_64) systemPipeR_2.12.0.tgz
macOS Binary (arm64) systemPipeR_2.12.0.tgz
Source Repository git clone https://git.bioconductor.org/packages/systemPipeR
Source Repository (Developer Access) git clone git@git.bioconductor.org:packages/systemPipeR
Bioc Package Browser https://code.bioconductor.org/browse/systemPipeR/
Package Short Url https://bioconductor.org/packages/systemPipeR/
Package Downloads Report Download Stats