Commit bb9c2c3a authored by Christian Arnold's avatar Christian Arnold

Documentation update

parent 1ddae0f9
......@@ -7,7 +7,7 @@ Try it out now!
The following quick start briefly summarizes the necessary steps to use our pipeline:
1. Install the necessary tools (Snakemake, samtools, bedtools, and Subread).
.. note:: Note that they all require Python 3.
.. note:: Note that all tools require Python 3.
We recommend installing them via conda, in which case the installation is as easy as
This diff is collapsed.
......@@ -188,7 +188,7 @@
<div><div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Note that they all require Python 3.</p>
<p class="last">Note that all tools require Python 3.</p>
<p>We recommend installing them via conda, in which case the installation is as easy as</p>
<div class="highlight-Bash"><div class="highlight"><pre><span></span>conda install -c bioconda snakemake bedtools samtools subread
This diff is collapsed.
......@@ -201,7 +201,14 @@
<li class="toctree-l2"><a class="reference internal" href="chapter2.html#input-metadata">Input metadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter2.html#output">Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter2.html#output">Output</a><ul>
<li class="toctree-l2"><a class="reference internal" href="chapter2.html#folder-final-output">FOLDER <code class="docutils literal"><span class="pre">FINAL_OUTPUT</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="chapter2.html#folder-peaks">FOLDER <code class="docutils literal"><span class="pre">PEAKS</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="chapter2.html#folder-tf-specific">FOLDER <code class="docutils literal"><span class="pre">TF-SPECIFIC</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="chapter2.html#folder-logs-and-benchmarks">FOLDER <code class="docutils literal"><span class="pre">LOGS_AND_BENCHMARKS</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="chapter2.html#folder-temp">FOLDER <code class="docutils literal"><span class="pre">TEMP</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter2.html#working-with-the-pipeline-and-frequently-asked-questions">Working with the pipeline and frequently asked questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter2.html#handling-errors">Handling errors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="chapter2.html#error-types">Error types</a></li>
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment