1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
|
.. _project_info-citations:
====================
Citing and Citations
====================
This section gives instructions on how to cite Snakemake and lists citing articles.
.. project_info-citing_snakemake:
----------------
Citing Snakemake
----------------
When using Snakemake for a publication, **please cite the following article** in you paper:
Cite This
=========
`Köster, Johannes and Rahmann, Sven. "Snakemake - A scalable bioinformatics workflow engine". Bioinformatics 2012. <https://bioinformatics.oxfordjournals.org/content/28/19/2520>`_
More References
===============
Another publication describing more of Snakemake internals:
`Köster, Johannes and Rahmann, Sven. "Building and Documenting Bioinformatics Workflows with Python-based Snakemake". Proceedings of the GCB 2012. <https://drops.dagstuhl.de/opus/volltexte/oasics-complete/oasics-vol26-gcb2012-complete.pdf>`_
And my PhD thesis which describes all algorithmic details:
`Johannes Köster, "Parallelization, Scalability, and Reproducibility in Next-Generation Sequencing Analysis", TU Dortmund 2014 <https://hdl.handle.net/2003/33940>`_
Project Pages
=============
If you publish a Snakemake workflow, consider adding a link to `the documentation <https://snakemake.readthedocs.io>`_ with `this badge <https://img.shields.io/badge/snakemake-≥5.6.0-brightgreen.svg?style=flat>`_ to your project page.
The markdown syntax is
.. sourcecode:: text
[![Snakemake](https://img.shields.io/badge/snakemake-≥5.6.0-brightgreen.svg?style=flat)](https://snakemake.readthedocs.io)
Replace the ``3.5.2`` with the minimum required Snakemake version.
You can also `change the style <https://shields.io/#styles>`_.
|