Skip to content

Commit

Permalink
added recipes to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ddecap committed May 10, 2016
1 parent 24545fe commit 2d1b620
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/source/contents/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,8 @@ Halvade is a Hadoop MapReduce implementation of the best practices pipeline from

Halvade depends on existing tools to run the pipeline, these tools require additional data besides the raw sequenced reads. This data consists of the human genome reference FASTA file, some additional files created using the reference and the dbSNP database. The index file used in the BWA or STAR aligners are created with the tools itself. The FASTA index and dictionary files used by the GATK are created by samtools and Picard. The naming convention for these files and additional information to run Halvade is provided in this Halvade documentation.

Recipes
=======

Two recipes have been created to run Halvade on WGS and RNA-seq data. These show all commands needed to run Halvade with the example data. The recipe for the DNA-seq pipeline can be found ` here <https://github.com/biointec/halvade/wiki/Recipe:-DNA-seq-with-Halvade-on-a-local-Hadoop-cluster>`_. The RNA-seq data is typically less big and therefore we chose to provide a recipe to run the Halvade rna pipeline on a single node Hadoop environment, which can be found `here <https://github.com/biointec/halvade/wiki/Recipe:-RNA-seq-with-Halvade-on-a-local-Hadoop-cluster>`_.

0 comments on commit 2d1b620

Please sign in to comment.