Skip to content

Commit

Permalink
Deployed 62c04e8 with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Jun 4, 2024
1 parent 9172adf commit 159367e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
18 changes: 16 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,14 +153,28 @@ <h2 id="quick-start">Quick Start</h2>
--input samplesheet.csv \
--outdir &lt;OUTDIR&gt; \
--kaiju_db kaiju_reference \
--diamond_db diamond_db \
--reference_fasta diamond_fasta \
--host_fasta host_reference_fasta \
--id_mapping id_mapping_file \
-profile &lt;docker/singularity/podman/shifter/charliecloud/conda/institute&gt;
</code></pre>
<h2 id="databases-and-references">Databases and references</h2>
<p>A question that pops up a lot is: Since Euryale requires a lot of reference parameters, where can I find these references?</p>
<p>One option is to execute EURYALE's download entry, which will download the necessary databases for you.
This is the recommended way to get started with the pipeline.
This uses the same sources as EURYALE's predecessor MEDUSA.</p>
<pre><code class="language-bash">nextflow run dalmolingroup/euryale \
--download_functional \
--download_kaiju \
--download_host \
--outdir &lt;output directory&gt; \
-entry download \
-profile &lt;docker/singularity/podman/shifter/charliecloud/conda/institute&gt;
</code></pre>
<p>In case you download the Kraken2 database (<code>--download_kraken</code>), make sure to extract it using the following command before using
it in the pipeline:</p>
<pre><code class="language-bash">tar -xvf kraken2_db.tar.gz
</code></pre>
<p>Below we provide a short list of places where you can find these databases.
But, of course, we're not limited to these references: Euryale should be able to process your own databases, should you want to build them yourself.</p>
<h3 id="alignment">Alignment</h3>
Expand Down Expand Up @@ -266,5 +280,5 @@ <h2 id="citations">Citations</h2>

<!--
MkDocs version : 1.6.0
Build Date UTC : 2024-06-04 14:08:04.296245+00:00
Build Date UTC : 2024-06-04 15:45:33.520725+00:00
-->
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

0 comments on commit 159367e

Please sign in to comment.