Skip to content
Light-weight Snakemake workflow for preprocessing and statistical analysis of RNA-seq data
Branch: master
Clone or download
Latest commit 975ffd0 May 26, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
envs Remove pandoc-citeproc from environment files Feb 19, 2019
example_data move back to base dir Mar 1, 2019
img Add benchmark figure as png instead of pdf Apr 25, 2019
scripts Set prior.count to 2 for consistency with previous version. Update NEWS. May 26, 2019
.Renviron Add .Renviron file to remove local R libraries on startup Sep 28, 2018
.travis.yml - add pandoc & pandoc-citeproc in the two environment files Feb 18, 2019
LICENSE update the work on creating linkedTxome from other branch Sep 23, 2018
NEWS Set prior.count to 2 for consistency with previous version. Update NEWS. May 26, 2019
README.md add sticker Mar 29, 2019
Snakefile add LC_COLLATE=C to sort command (issue #85) Apr 27, 2019
config.yaml
version increase version May 21, 2019

README.md

ARMOR workflow

Build Status

ARMOR (Automated Reproducible MOdular RNA-seq) is a Snakemake workflow, aimed at performing a typical RNA-seq workflow in a reproducible, automated, and partially contained manner. It is implemented such that alternative or similar analysis can be added or removed.

ARMOR consists of a Snakefile, a conda environment file (envs/environment.yaml) a configuration file (config.yaml) and a set of R scripts, to perform quality control, preprocessing and differential expression analysis of RNA-seq data. The output can be combined with the iSEE R package to generate a shiny application for browsing and sharing the results.

By default, the pipeline performs all the steps shown in the diagram below. However, you can turn off any combination of the light-colored steps (e.g STAR alignment or DRIMSeq analysis) in the config.yaml file.

Advanced use: If you prefer other software to run one of the outlined steps (e.g. DESeq2 over edgeR, or kallisto over Salmon), you can use the software of your preference provided you have your own script(s), and change some lines within the Snakefile. If you think your "custom rule" might be of use to a broader audience, let us know by opening an issue.

Using the ARMOR workflow

Assuming that snakemake and conda are installed (and your system has the necessary libraries to compile R packages), you can use the following commands on a test dataset:

git clone https://github.com/csoneson/ARMOR.git
cd ARMOR && snakemake --use-conda

To use the ARMOR workflow on your own data, follow the steps outlined in the wiki.

Workflow graph

DAG
Blue circles are rules run in R, orange circles from software called as shell commands. Dashed lines and light-colored circles are optional rules, controlled in config.yaml

Contributors

Current contributors include:

You can’t perform that action at this time.