[med-svn] [Git][med-team/spades][upstream] New upstream version 3.15.5+dfsg
Étienne Mollier (@emollier)
gitlab at salsa.debian.org
Sun Jul 24 08:25:29 BST 2022
Étienne Mollier pushed to branch upstream at Debian Med / spades
Commits:
3d6cb8fc by Étienne Mollier at 2022-07-24T07:28:33+02:00
New upstream version 3.15.5+dfsg
- - - - -
17 changed files:
- README.md
- assembler/VERSION
- assembler/changelog.html
- assembler/manual.html
- assembler/src/cmake/pack.cmake
- + assembler/src/common/assembly_graph/handlers/used_edge_handler.hpp
- assembler/src/common/modules/alignment/pacbio/gap_filler.hpp
- assembler/src/projects/spades/contig_output_stage.cpp
- assembler/src/projects/spades/domain_matcher.cpp
- assembler/src/spades_pipeline/options_parser.py
- assembler/src/spades_pipeline/stages/correction_stage.py
- assembler/src/spades_pipeline/stages/error_correction_stage.py
- assembler/src/spades_pipeline/stages/pipeline.py
- − assembler/src/spades_pipeline/stages/scaffold_correction_stage.py
- assembler/src/spades_pipeline/stages/spades_iteration_stage.py
- assembler/src/spades_pipeline/stages/spades_stage.py
- assembler/src/spades_pipeline/support.py
Changes:
=====================================
README.md
=====================================
@@ -6,7 +6,7 @@
[](code_of_conduct.md)
-<font size=20>__SPAdes 3.15.4 Manual__</font>
+<font size=20>__SPAdes 3.15.5 Manual__</font>
1. [About SPAdes](#sec1) </br>
1.1. [Supported data types](#sec1.1)</br>
@@ -42,7 +42,7 @@
<a name="sec1"></a>
# About SPAdes
-SPAdes - St. Petersburg genome assembler - is an assembly toolkit containing various assembly pipelines. This manual will help you to install and run SPAdes. SPAdes version 3.15.4 was released under GPLv2 on February 1, 2021 and can be downloaded from <http://cab.spbu.ru/software/spades/>.
+SPAdes - St. Petersburg genome assembler - is an assembly toolkit containing various assembly pipelines. This manual will help you to install and run SPAdes. SPAdes version 3.15.5 was released under GPLv2 on July 14th, 2022 and can be downloaded from <http://cab.spbu.ru/software/spades/>.
The latest SPAdes paper describing various pipelines in a protocol format is available [here](https://currentprotocols.onlinelibrary.wiley.com/doi/abs/10.1002/cpbi.102).
@@ -51,11 +51,11 @@ The latest SPAdes paper describing various pipelines in a protocol format is ava
The current version of SPAdes works with Illumina or IonTorrent reads and is capable of providing hybrid assemblies using PacBio, Oxford Nanopore and Sanger reads. You can also provide additional contigs that will be used as long reads.
-Version 3.15.4 of SPAdes supports paired-end reads, mate-pairs and unpaired reads. SPAdes can take as input several paired-end and mate-pair libraries simultaneously. Note, that SPAdes was initially designed for small genomes. It was tested on bacterial (both single-cell MDA and standard isolates), fungal and other small genomes. SPAdes is not intended for larger genomes (e.g. mammalian size genomes). For such purposes you can use it at your own risk.
+Version 3.15.5 of SPAdes supports paired-end reads, mate-pairs and unpaired reads. SPAdes can take as input several paired-end and mate-pair libraries simultaneously. Note, that SPAdes was initially designed for small genomes. It was tested on bacterial (both single-cell MDA and standard isolates), fungal and other small genomes. SPAdes is not intended for larger genomes (e.g. mammalian size genomes). For such purposes you can use it at your own risk.
If you have high-coverage data for bacterial/viral isolate or multi-cell organism, we highly recommend to use [`--isolate`](#isolate) option.
-SPAdes 3.15.4 includes the following additional pipelines:
+SPAdes 3.15.5 includes the following additional pipelines:
- metaSPAdes - a pipeline for metagenomic data sets (see [metaSPAdes options](#meta)).
- plasmidSPAdes - a pipeline for extracting and assembling plasmids from WGS data sets (see [plasmid options](#plasmid)).
@@ -187,13 +187,13 @@ In case of successful installation the following files will be placed in the `bi
<a name="sec2.1"></a>
## Downloading SPAdes Linux binaries
-To download [SPAdes Linux binaries](http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4-Linux.tar.gz) and extract them, go to the directory in which you wish SPAdes to be installed and run:
+To download [SPAdes Linux binaries](http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5-Linux.tar.gz) and extract them, go to the directory in which you wish SPAdes to be installed and run:
``` bash
- wget http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4-Linux.tar.gz
- tar -xzf SPAdes-3.15.4-Linux.tar.gz
- cd SPAdes-3.15.4-Linux/bin/
+ wget http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5-Linux.tar.gz
+ tar -xzf SPAdes-3.15.5-Linux.tar.gz
+ cd SPAdes-3.15.5-Linux/bin/
```
In this case you do not need to run any installation scripts - SPAdes is ready to use. We also suggest adding SPAdes installation directory to the `PATH` variable. []()
@@ -203,13 +203,13 @@ Note, that pre-build binaries do not work on new Linux kernels.
<a name="sec2.2"></a>
## Downloading SPAdes binaries for Mac
-To obtain [SPAdes binaries for Mac](http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4-Darwin.tar.gz), go to the directory in which you wish SPAdes to be installed and run:
+To obtain [SPAdes binaries for Mac](http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5-Darwin.tar.gz), go to the directory in which you wish SPAdes to be installed and run:
``` bash
- curl http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4-Darwin.tar.gz -o SPAdes-3.15.4-Darwin.tar.gz
- tar -zxf SPAdes-3.15.4-Darwin.tar.gz
- cd SPAdes-3.15.4-Darwin/bin/
+ curl http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5-Darwin.tar.gz -o SPAdes-3.15.5-Darwin.tar.gz
+ tar -zxf SPAdes-3.15.5-Darwin.tar.gz
+ cd SPAdes-3.15.5-Darwin/bin/
```
Just as in Linux, SPAdes is ready to use and no further installation steps are required. We also suggest adding SPAdes installation directory to the `PATH` variable. []()
@@ -224,13 +224,13 @@ If you wish to compile SPAdes by yourself you will need the following libraries
- zlib
- libbz2
-If you meet these requirements, you can download the [SPAdes source code](http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4.tar.gz):
+If you meet these requirements, you can download the [SPAdes source code](http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5.tar.gz):
``` bash
- wget http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4.tar.gz
- tar -xzf SPAdes-3.15.4.tar.gz
- cd SPAdes-3.15.4
+ wget http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5.tar.gz
+ tar -xzf SPAdes-3.15.5.tar.gz
+ cd SPAdes-3.15.5
```
and build it with the following script:
@@ -309,7 +309,7 @@ Thank you for using SPAdes!
SPAdes takes as input paired-end reads, mate-pairs and single (unpaired) reads in FASTA and FASTQ. For IonTorrent data SPAdes also supports unpaired reads in unmapped BAM format (like the one produced by Torrent Server). However, in order to run read error correction, reads should be in FASTQ or BAM format. Sanger, Oxford Nanopore and PacBio CLR reads can be provided in both formats since SPAdes does not run error correction for these types of data.
-To run SPAdes 3.15.4 you need at least one library of the following types:
+To run SPAdes 3.15.5 you need at least one library of the following types:
- Illumina paired-end/high-quality mate-pairs/unpaired reads
- IonTorrent paired-end/high-quality mate-pairs/unpaired reads
=====================================
assembler/VERSION
=====================================
@@ -1 +1 @@
-3.15.4
+3.15.5
=====================================
assembler/changelog.html
=====================================
@@ -3,6 +3,15 @@
<h2>SPAdes Genome Assembler changelog</h2>
+
+<h3>SPAdes 3.15.5, 14 July 2022</h3>
+
+<p>NEW: Support DNA HMMs. <p>
+
+<p>FIX: use-after-free in PB aligner. <p>
+
+<p>FIX: duplicated sequences in metaplasmid / metaviral mode. <p>
+
<h3>SPAdes 3.15.4, 1 February 2022</h3>
<p>FIX: MacOS Monterey memory limit failure. <p>
=====================================
assembler/manual.html
=====================================
@@ -1,10 +1,10 @@
-<html> <head> <title>SPAdes 3.15.4 Manual</title> <style type="text/css"> .highlight pre { background-color: #f0f2f4; border-radius: 2px; font-size: 100%; line-height: 1.45; overflow: auto; padding: 16px; } </style> </head> <body><p dir="auto"><a href="http://chihua.cab.spbu.ru:3000/buildConfiguration/SPAdesBasicTests_RunAll?mode=builds" rel="nofollow"><img src="https://camo.githubusercontent.com/21b928ad15b5735360cb555da4951c8dee2ef5633fd61c3fce22bb157f9dc1c5/687474703a2f2f6368696875612e6361622e737062752e72753a333030302f6170702f726573742f6275696c64732f6275696c64547970653a2869643a535041646573426173696354657374735f52756e416c6c292f73746174757349636f6e" alt="TeamCity Simple Build Status" data-canonical-src="http://chihua.cab.spbu.ru:3000/app/rest/builds/buildType:(id:SPAdesBasicTests_RunAll)/statusIcon" style="max-width: 100%;"></a><br>
+<html> <head> <title>SPAdes 3.15.5 Manual</title> <style type="text/css"> .highlight pre { background-color: #f0f2f4; border-radius: 2px; font-size: 100%; line-height: 1.45; overflow: auto; padding: 16px; } </style> </head> <body><p dir="auto"><a href="http://chihua.cab.spbu.ru:3000/buildConfiguration/SPAdesBasicTests_RunAll?mode=builds" rel="nofollow"><img src="https://camo.githubusercontent.com/21b928ad15b5735360cb555da4951c8dee2ef5633fd61c3fce22bb157f9dc1c5/687474703a2f2f6368696875612e6361622e737062752e72753a333030302f6170702f726573742f6275696c64732f6275696c64547970653a2869643a535041646573426173696354657374735f52756e416c6c292f73746174757349636f6e" alt="TeamCity Simple Build Status" data-canonical-src="http://chihua.cab.spbu.ru:3000/app/rest/builds/buildType:(id:SPAdesBasicTests_RunAll)/statusIcon" style="max-width: 100%;"></a><br>
<a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0" rel="nofollow"><img src="https://camo.githubusercontent.com/c76156a44047d8a6b64fc1fa16118996c422cff2959c1ae82127260b29e990ef/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e63652d47504c76322d626c7565" alt="License" data-canonical-src="https://img.shields.io/badge/licence-GPLv2-blue" style="max-width: 100%;"></a><br>
<a href="https://github.com/ablab/spades/releases/"><img src="https://camo.githubusercontent.com/b67a7145a28ab5560f54b811c18353c4771fa5ae62a344f4d5e53a4c0a9da5b4/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f61626c61622f737061646573" alt="GitHub release (latest by date)" data-canonical-src="https://img.shields.io/github/v/release/ablab/spades" style="max-width: 100%;"></a><br>
<a href="https://github.com/ablab/spades/releases"><img src="https://camo.githubusercontent.com/a8ba4fbdefabcc61b7a4d41a40fb19c92e96d49717bd24414252a4f460a34f09/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f646f776e6c6f6164732f61626c61622f7370616465732f746f74616c2e7376673f7374796c653d736f6369616c266c6f676f3d676974687562266c6162656c3d446f776e6c6f6164" alt="GitHub Downloads" data-canonical-src="https://img.shields.io/github/downloads/ablab/spades/total.svg?style=social&logo=github&label=Download" style="max-width: 100%;"></a><br>
<a href="https://anaconda.org/bioconda/spades" rel="nofollow"><img src="https://camo.githubusercontent.com/24a3286de783bcb188f9e010b910a26db4026ecf4b05f184fb3f71f4892f6c77/68747470733a2f2f616e61636f6e64612e6f72672f62696f636f6e64612f7370616465732f6261646765732f646f776e6c6f6164732e737667" alt="BioConda Downloads" data-canonical-src="https://anaconda.org/bioconda/spades/badges/downloads.svg" style="max-width: 100%;"></a><br>
<a href="code_of_conduct.md"><img src="https://camo.githubusercontent.com/9a5e1f5558bc77986d831a81a6f80819da5a94c13d3aca339a0993119f535a06/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f436f6e7472696275746f72253230436f76656e616e742d322e302d3462616161612e737667" alt="Contributor Covenant" data-canonical-src="https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg" style="max-width: 100%;"></a></p>
-<p dir="auto"><strong>SPAdes 3.15.4 Manual</strong></p>
+<p dir="auto"><strong>SPAdes 3.15.5 Manual</strong></p>
<ol dir="auto">
<li><a href="#sec1">About SPAdes</a> <br>
1.1. <a href="#sec1.1">Supported data types</a><br>
@@ -39,14 +39,14 @@
</ol>
<p dir="auto"><a name="sec1"></a></p>
<h1 dir="auto">About SPAdes</h1>
-<p dir="auto">SPAdes - St. Petersburg genome assembler - is an assembly toolkit containing various assembly pipelines. This manual will help you to install and run SPAdes. SPAdes version 3.15.4 was released under GPLv2 on February 1, 2021 and can be downloaded from <a href="http://cab.spbu.ru/software/spades/" rel="nofollow">http://cab.spbu.ru/software/spades/</a>.</p>
+<p dir="auto">SPAdes - St. Petersburg genome assembler - is an assembly toolkit containing various assembly pipelines. This manual will help you to install and run SPAdes. SPAdes version 3.15.5 was released under GPLv2 on July 14th, 2022 and can be downloaded from <a href="http://cab.spbu.ru/software/spades/" rel="nofollow">http://cab.spbu.ru/software/spades/</a>.</p>
<p dir="auto">The latest SPAdes paper describing various pipelines in a protocol format is available <a href="https://currentprotocols.onlinelibrary.wiley.com/doi/abs/10.1002/cpbi.102" rel="nofollow">here</a>.</p>
<p dir="auto"><a name="sec1.1"></a></p>
<h2 dir="auto">Supported data types</h2>
<p dir="auto">The current version of SPAdes works with Illumina or IonTorrent reads and is capable of providing hybrid assemblies using PacBio, Oxford Nanopore and Sanger reads. You can also provide additional contigs that will be used as long reads.</p>
-<p dir="auto">Version 3.15.4 of SPAdes supports paired-end reads, mate-pairs and unpaired reads. SPAdes can take as input several paired-end and mate-pair libraries simultaneously. Note, that SPAdes was initially designed for small genomes. It was tested on bacterial (both single-cell MDA and standard isolates), fungal and other small genomes. SPAdes is not intended for larger genomes (e.g. mammalian size genomes). For such purposes you can use it at your own risk.</p>
-<p dir="auto">If you have high-coverage data for bacterial/viral isolate or multi-cell organism, we highly recommend to use <a href="#isolate"><code>--isolate</code></a> option.</p>
-<p dir="auto">SPAdes 3.15.4 includes the following additional pipelines:</p>
+<p dir="auto">Version 3.15.5 of SPAdes supports paired-end reads, mate-pairs and unpaired reads. SPAdes can take as input several paired-end and mate-pair libraries simultaneously. Note, that SPAdes was initially designed for small genomes. It was tested on bacterial (both single-cell MDA and standard isolates), fungal and other small genomes. SPAdes is not intended for larger genomes (e.g. mammalian size genomes). For such purposes you can use it at your own risk.</p>
+<p dir="auto">If you have high-coverage data for bacterial/viral isolate or multi-cell organism, we highly recommend to use <a href="#isolate"><code class="notranslate">--isolate</code></a> option.</p>
+<p dir="auto">SPAdes 3.15.5 includes the following additional pipelines:</p>
<ul dir="auto">
<li>metaSPAdes - a pipeline for metagenomic data sets (see <a href="#meta">metaSPAdes options</a>).</li>
<li>plasmidSPAdes - a pipeline for extracting and assembling plasmids from WGS data sets (see <a href="#plasmid">plasmid options</a>).</li>
@@ -57,7 +57,7 @@
<li>coronaSPAdes is a special mode of rnaviralSPAdes specifically aimed for SARS-CoV-2 <em>de novo</em> assembly.</li>
<li>truSPAdes - (DEPRECATED) a module for TruSeq barcode assembly (see <a href="truspades_manual.html">truSPAdes manual</a>).</li>
</ul>
-<p dir="auto">In addition, we provide several stand-alone binaries with relatively simple command-line interface: <a href="#sec4.1">k-mer counting</a> (<code>spades-kmercounter</code>), <a href="#sec4.2">assembly graph construction</a> (<code>spades-gbuilder</code>) and <a href="#sec4.3">long read to graph aligner</a> (<code>spades-gmapper</code>). To learn options of these tools you can either run them without any parameters or read <a href="#sec4">this section</a>.</p>
+<p dir="auto">In addition, we provide several stand-alone binaries with relatively simple command-line interface: <a href="#sec4.1">k-mer counting</a> (<code class="notranslate">spades-kmercounter</code>), <a href="#sec4.2">assembly graph construction</a> (<code class="notranslate">spades-gbuilder</code>) and <a href="#sec4.3">long read to graph aligner</a> (<code class="notranslate">spades-gmapper</code>). To learn options of these tools you can either run them without any parameters or read <a href="#sec4">this section</a>.</p>
<p dir="auto"><a href=""></a></p>
<p dir="auto"><a name="sec1.2"></a></p>
<h2 dir="auto">SPAdes pipeline</h2>
@@ -139,42 +139,42 @@
<p dir="auto"><a name="sec2"></a></p>
<h1 dir="auto">Installation</h1>
<p dir="auto">SPAdes requires a 64-bit Linux system or Mac OS and Python (supported versions are Python 2.7, and Python3: 3.2 and higher) to be pre-installed on it. To obtain SPAdes you can either download binaries or download source code and compile it yourself. <a href=""></a></p>
-<p dir="auto">In case of successful installation the following files will be placed in the <code>bin</code> directory:</p>
+<p dir="auto">In case of successful installation the following files will be placed in the <code class="notranslate">bin</code> directory:</p>
<ul dir="auto">
-<li><code>spades.py</code> (main executable script)</li>
-<li><code>metaspades.py</code> (main executable script for <a href="#meta">metaSPAdes</a>)</li>
-<li><code>plasmidspades.py</code> (main executable script for <a href="#plasmid">plasmidSPAdes</a>)</li>
-<li><code>metaplasmidspades.py</code> (main executable script for <a href="#metaextrachromosomal">metaplasmidSPAdes</a>)</li>
-<li><code>metaviralspades.py</code> (main executable script for <a href="#metaextrachromosomal">metaviralSPAdes</a>)</li>
-<li><code>rnaspades.py</code> (main executable script for <a href="rnaspades_manual.html">rnaSPAdes</a>)</li>
-<li><code>truspades.py</code> (main executable script for <a href="truspades_manual.html">truSPAdes</a>, DEPRECATED)</li>
-<li><code>rnaviralspades.py</code> (main executable script for rnaviralSPAdes)</li>
-<li><code>coronaspades.py</code> (wrapper script for coronaSPAdes mode)</li>
-<li><code>spades-core</code> (assembly module)</li>
-<li><code>spades-gbuilder</code> (standalone graph builder application)</li>
-<li><code>spades-gmapper</code> (standalone long read to graph aligner)</li>
-<li><code>spades-kmercount</code> (standalone k-mer counting application)</li>
-<li><code>spades-hammer</code> (read error correcting module for Illumina reads)</li>
-<li><code>spades-ionhammer</code> (read error correcting module for IonTorrent reads)</li>
-<li><code>spades-bwa</code> (<a href="http://bio-bwa.sourceforge.net" rel="nofollow">BWA</a> alignment module which is required for mismatch correction)</li>
-<li><code>spades-corrector-core</code> (mismatch correction module)</li>
-<li><code>spades-truseq-scfcorrection</code> (executable used in truSPAdes pipeline)</li>
+<li><code class="notranslate">spades.py</code> (main executable script)</li>
+<li><code class="notranslate">metaspades.py</code> (main executable script for <a href="#meta">metaSPAdes</a>)</li>
+<li><code class="notranslate">plasmidspades.py</code> (main executable script for <a href="#plasmid">plasmidSPAdes</a>)</li>
+<li><code class="notranslate">metaplasmidspades.py</code> (main executable script for <a href="#metaextrachromosomal">metaplasmidSPAdes</a>)</li>
+<li><code class="notranslate">metaviralspades.py</code> (main executable script for <a href="#metaextrachromosomal">metaviralSPAdes</a>)</li>
+<li><code class="notranslate">rnaspades.py</code> (main executable script for <a href="rnaspades_manual.html">rnaSPAdes</a>)</li>
+<li><code class="notranslate">truspades.py</code> (main executable script for <a href="truspades_manual.html">truSPAdes</a>, DEPRECATED)</li>
+<li><code class="notranslate">rnaviralspades.py</code> (main executable script for rnaviralSPAdes)</li>
+<li><code class="notranslate">coronaspades.py</code> (wrapper script for coronaSPAdes mode)</li>
+<li><code class="notranslate">spades-core</code> (assembly module)</li>
+<li><code class="notranslate">spades-gbuilder</code> (standalone graph builder application)</li>
+<li><code class="notranslate">spades-gmapper</code> (standalone long read to graph aligner)</li>
+<li><code class="notranslate">spades-kmercount</code> (standalone k-mer counting application)</li>
+<li><code class="notranslate">spades-hammer</code> (read error correcting module for Illumina reads)</li>
+<li><code class="notranslate">spades-ionhammer</code> (read error correcting module for IonTorrent reads)</li>
+<li><code class="notranslate">spades-bwa</code> (<a href="http://bio-bwa.sourceforge.net" rel="nofollow">BWA</a> alignment module which is required for mismatch correction)</li>
+<li><code class="notranslate">spades-corrector-core</code> (mismatch correction module)</li>
+<li><code class="notranslate">spades-truseq-scfcorrection</code> (executable used in truSPAdes pipeline)</li>
</ul>
<p dir="auto"><a name="sec2.1"></a></p>
<h2 dir="auto">Downloading SPAdes Linux binaries</h2>
-<p dir="auto">To download <a href="http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4-Linux.tar.gz" rel="nofollow">SPAdes Linux binaries</a> and extract them, go to the directory in which you wish SPAdes to be installed and run:</p>
-<div class="highlight highlight-source-shell"><pre> wget http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4-Linux.tar.gz
- tar -xzf SPAdes-3.15.4-Linux.tar.gz
- <span class="pl-c1">cd</span> SPAdes-3.15.4-Linux/bin/</pre></div>
-<p dir="auto">In this case you do not need to run any installation scripts - SPAdes is ready to use. We also suggest adding SPAdes installation directory to the <code>PATH</code> variable. <a href=""></a></p>
+<p dir="auto">To download <a href="http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5-Linux.tar.gz" rel="nofollow">SPAdes Linux binaries</a> and extract them, go to the directory in which you wish SPAdes to be installed and run:</p>
+<div class="highlight highlight-source-shell"><pre> wget http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5-Linux.tar.gz
+ tar -xzf SPAdes-3.15.5-Linux.tar.gz
+ <span class="pl-c1">cd</span> SPAdes-3.15.5-Linux/bin/</pre></div>
+<p dir="auto">In this case you do not need to run any installation scripts - SPAdes is ready to use. We also suggest adding SPAdes installation directory to the <code class="notranslate">PATH</code> variable. <a href=""></a></p>
<p dir="auto">Note, that pre-build binaries do not work on new Linux kernels.</p>
<p dir="auto"><a name="sec2.2"></a></p>
<h2 dir="auto">Downloading SPAdes binaries for Mac</h2>
-<p dir="auto">To obtain <a href="http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4-Darwin.tar.gz" rel="nofollow">SPAdes binaries for Mac</a>, go to the directory in which you wish SPAdes to be installed and run:</p>
-<div class="highlight highlight-source-shell"><pre> curl http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4-Darwin.tar.gz -o SPAdes-3.15.4-Darwin.tar.gz
- tar -zxf SPAdes-3.15.4-Darwin.tar.gz
- <span class="pl-c1">cd</span> SPAdes-3.15.4-Darwin/bin/</pre></div>
-<p dir="auto">Just as in Linux, SPAdes is ready to use and no further installation steps are required. We also suggest adding SPAdes installation directory to the <code>PATH</code> variable. <a href=""></a></p>
+<p dir="auto">To obtain <a href="http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5-Darwin.tar.gz" rel="nofollow">SPAdes binaries for Mac</a>, go to the directory in which you wish SPAdes to be installed and run:</p>
+<div class="highlight highlight-source-shell"><pre> curl http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5-Darwin.tar.gz -o SPAdes-3.15.5-Darwin.tar.gz
+ tar -zxf SPAdes-3.15.5-Darwin.tar.gz
+ <span class="pl-c1">cd</span> SPAdes-3.15.5-Darwin/bin/</pre></div>
+<p dir="auto">Just as in Linux, SPAdes is ready to use and no further installation steps are required. We also suggest adding SPAdes installation directory to the <code class="notranslate">PATH</code> variable. <a href=""></a></p>
<p dir="auto"><a name="sec2.3"></a></p>
<h2 dir="auto">Downloading and compiling SPAdes source code</h2>
<p dir="auto">If you wish to compile SPAdes by yourself you will need the following libraries to be pre-installed:</p>
@@ -184,27 +184,27 @@
<li>zlib</li>
<li>libbz2</li>
</ul>
-<p dir="auto">If you meet these requirements, you can download the <a href="http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4.tar.gz" rel="nofollow">SPAdes source code</a>:</p>
-<div class="highlight highlight-source-shell"><pre> wget http://cab.spbu.ru/files/release3.15.4/SPAdes-3.15.4.tar.gz
- tar -xzf SPAdes-3.15.4.tar.gz
- <span class="pl-c1">cd</span> SPAdes-3.15.4</pre></div>
+<p dir="auto">If you meet these requirements, you can download the <a href="http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5.tar.gz" rel="nofollow">SPAdes source code</a>:</p>
+<div class="highlight highlight-source-shell"><pre> wget http://cab.spbu.ru/files/release3.15.5/SPAdes-3.15.5.tar.gz
+ tar -xzf SPAdes-3.15.5.tar.gz
+ <span class="pl-c1">cd</span> SPAdes-3.15.5</pre></div>
<p dir="auto">and build it with the following script:</p>
<div class="highlight highlight-source-shell"><pre> ./spades_compile.sh</pre></div>
-<p dir="auto">SPAdes will be built in the directory <code>./bin</code>. If you wish to install SPAdes into another directory, you can specify full path of destination folder by running the following command in <code>bash</code> or <code>sh</code>:</p>
+<p dir="auto">SPAdes will be built in the directory <code class="notranslate">./bin</code>. If you wish to install SPAdes into another directory, you can specify full path of destination folder by running the following command in <code class="notranslate">bash</code> or <code class="notranslate">sh</code>:</p>
<div class="highlight highlight-source-shell"><pre> PREFIX=<span class="pl-k"><</span>destination_dir<span class="pl-k">></span> ./spades_compile.sh</pre></div>
<p dir="auto">for example:</p>
<div class="highlight highlight-source-shell"><pre> PREFIX=/usr/local ./spades_compile.sh</pre></div>
-<p dir="auto">which will install SPAdes into <code>/usr/local/bin</code>.</p>
-<p dir="auto">After installation you will get the same files (listed above) in <code>./bin</code> directory (or <code><destination_dir>/bin</code> if you specified PREFIX). We also suggest adding <code>bin</code> directory to the <code>PATH</code> variable. <a href=""></a></p>
+<p dir="auto">which will install SPAdes into <code class="notranslate">/usr/local/bin</code>.</p>
+<p dir="auto">After installation you will get the same files (listed above) in <code class="notranslate">./bin</code> directory (or <code class="notranslate"><destination_dir>/bin</code> if you specified PREFIX). We also suggest adding <code class="notranslate">bin</code> directory to the <code class="notranslate">PATH</code> variable. <a href=""></a></p>
<p dir="auto"><a name="sec2.4"></a></p>
<h2 dir="auto">Verifying your installation</h2>
<p dir="auto">For testing purposes, SPAdes comes with a toy data set (reads that align to first 1000 bp of <em>E. coli</em>). To try SPAdes on this data set, run:</p>
<div class="highlight highlight-source-shell"><pre> <span class="pl-k"><</span>spades installation dir<span class="pl-k">></span>/bin/spades.py --test</pre></div>
-<p dir="auto">If you added <code>bin</code> folder from SPAdes installation directory to the <code>PATH</code> variable, you can run:</p>
+<p dir="auto">If you added <code class="notranslate">bin</code> folder from SPAdes installation directory to the <code class="notranslate">PATH</code> variable, you can run:</p>
<div class="highlight highlight-source-shell"><pre> spades.py --test</pre></div>
-<p dir="auto">For the simplicity we further assume that <code>bin</code> folder from SPAdes installation directory is added to the <code>PATH</code> variable.</p>
+<p dir="auto">For the simplicity we further assume that <code class="notranslate">bin</code> folder from SPAdes installation directory is added to the <code class="notranslate">PATH</code> variable.</p>
<p dir="auto">If the installation is successful, you will find the following information at the end of the log:</p>
-<pre lang="plain"><code>
+<pre lang="plain" class="notranslate"><code class="notranslate">
===== Assembling finished. Used k-mer sizes: 21, 33, 55
* Corrected reads are in spades_test/corrected/
@@ -229,7 +229,7 @@ Thank you for using SPAdes!
<a name="input"></a></p>
<h2 dir="auto">SPAdes input</h2>
<p dir="auto">SPAdes takes as input paired-end reads, mate-pairs and single (unpaired) reads in FASTA and FASTQ. For IonTorrent data SPAdes also supports unpaired reads in unmapped BAM format (like the one produced by Torrent Server). However, in order to run read error correction, reads should be in FASTQ or BAM format. Sanger, Oxford Nanopore and PacBio CLR reads can be provided in both formats since SPAdes does not run error correction for these types of data.</p>
-<p dir="auto">To run SPAdes 3.15.4 you need at least one library of the following types:</p>
+<p dir="auto">To run SPAdes 3.15.5 you need at least one library of the following types:</p>
<ul dir="auto">
<li>Illumina paired-end/high-quality mate-pairs/unpaired reads</li>
<li>IonTorrent paired-end/high-quality mate-pairs/unpaired reads</li>
@@ -254,7 +254,7 @@ Thank you for using SPAdes!
<li>In file pairs. In this case left and right reads are placed in different files and go in the same order in respective files.</li>
<li>In interleaved files. In this case, the reads are interlaced, so that each right read goes after the corresponding paired left read.</li>
</ul>
-<p dir="auto">For example, Illumina produces paired-end reads in two files: <code>R1.fastq</code> and <code>R2.fastq</code>. If you choose to store reads in file pairs make sure that for every read from <code>R1.fastq</code> the corresponding paired read from <code>R2.fastq</code> is placed in the respective paired file on the same line number. If you choose to use interleaved files, every read from <code>R1.fastq</code> should be followed by the corresponding paired read from <code>R2.fastq</code>.</p>
+<p dir="auto">For example, Illumina produces paired-end reads in two files: <code class="notranslate">R1.fastq</code> and <code class="notranslate">R2.fastq</code>. If you choose to store reads in file pairs make sure that for every read from <code class="notranslate">R1.fastq</code> the corresponding paired read from <code class="notranslate">R2.fastq</code> is placed in the respective paired file on the same line number. If you choose to use interleaved files, every read from <code class="notranslate">R1.fastq</code> should be followed by the corresponding paired read from <code class="notranslate">R2.fastq</code>.</p>
<p dir="auto">If adapter and/or quality trimming software has been used prior to assembly, files with the orphan reads can be provided as "single read files" for the corresponding read-pair library.</p>
<p dir="auto"><a name="input:merged"></a><br>
If you have merged some of the reads from your paired-end (not mate-pair or high-quality mate-pair) library (using tools s.a. <a href="https://jgi.doe.gov/data-and-tools/bbtools/bb-tools-user-guide/bbmerge-guide/" rel="nofollow">BBMerge</a> or <a href="https://bitbucket.org/yaoornl/align_test/overview" rel="nofollow">STORM</a>), you should provide the file with resulting reads as a "merged read file" for the corresponding library.<br>
@@ -269,44 +269,44 @@ Note that non-empty files with the remaining unmerged left/right reads (separate
<h3 dir="auto">PacBio and Oxford Nanopore reads</h3>
<p dir="auto">SPAdes can take as an input an unlimited number of PacBio and Oxford Nanopore libraries.</p>
<p dir="auto">PacBio CLR and Oxford Nanopore reads are used for hybrid assemblies (e.g. with Illumina or IonTorrent). There is no need to pre-correct this kind of data. SPAdes will use PacBio CLR and Oxford Nanopore reads for gap closure and repeat resolution.</p>
-<p dir="auto">For PacBio you just need to have filtered subreads in FASTQ/FASTA format. Provide these filtered subreads using <code>--pacbio</code> option. Oxford Nanopore reads are provided with <code>--nanopore</code> option.</p>
+<p dir="auto">For PacBio you just need to have filtered subreads in FASTQ/FASTA format. Provide these filtered subreads using <code class="notranslate">--pacbio</code> option. Oxford Nanopore reads are provided with <code class="notranslate">--nanopore</code> option.</p>
<p dir="auto">PacBio CCS/Reads of Insert reads or pre-corrected (using third-party software) PacBio CLR / Oxford Nanopore reads can be simply provided as single reads to SPAdes.</p>
<p dir="auto"><a name="input:contigs"></a></p>
<h3 dir="auto">Additional contigs</h3>
-<p dir="auto">In case you have contigs of the same genome generated by other assembler(s) and you wish to merge them into SPAdes assembly, you can specify additional contigs using <code>--trusted-contigs</code> or <code>--untrusted-contigs</code>. First option is used when high quality contigs are available. These contigs will be used for graph construction, gap closure and repeat resolution. Second option is used for less reliable contigs that may have more errors or contigs of unknown quality. These contigs will be used only for gap closure and repeat resolution. The number of additional contigs is unlimited.</p>
+<p dir="auto">In case you have contigs of the same genome generated by other assembler(s) and you wish to merge them into SPAdes assembly, you can specify additional contigs using <code class="notranslate">--trusted-contigs</code> or <code class="notranslate">--untrusted-contigs</code>. First option is used when high quality contigs are available. These contigs will be used for graph construction, gap closure and repeat resolution. Second option is used for less reliable contigs that may have more errors or contigs of unknown quality. These contigs will be used only for gap closure and repeat resolution. The number of additional contigs is unlimited.</p>
<p dir="auto">Note, that SPAdes does not perform assembly using genomes of closely-related species. Only contigs of the same genome should be specified.</p>
<p dir="auto"><a href=""></a><br>
<a name="sec3.2"></a></p>
<h2 dir="auto">SPAdes command line options</h2>
<p dir="auto">To run SPAdes from the command line, type</p>
<div class="highlight highlight-source-shell"><pre> spades.py [options] -o <span class="pl-k"><</span>output_dir<span class="pl-k">></span></pre></div>
-<p dir="auto">Note that we assume that <code>bin</code> forder from SPAdes installation directory is added to the <code>PATH</code> variable (provide full path to SPAdes executable otherwise: <code><spades installation dir>/bin/spades.py</code>). <a href=""></a></p>
+<p dir="auto">Note that we assume that <code class="notranslate">bin</code> forder from SPAdes installation directory is added to the <code class="notranslate">PATH</code> variable (provide full path to SPAdes executable otherwise: <code class="notranslate"><spades installation dir>/bin/spades.py</code>). <a href=""></a></p>
<p dir="auto"><a name="basicopt"></a></p>
<h3 dir="auto">Basic options</h3>
-<p dir="auto"><code>-o <output_dir> </code><br>
+<p dir="auto"><code class="notranslate">-o <output_dir> </code><br>
Specify the output directory. Required option.</p>
<p dir="auto"><a href=""></a></p>
<p dir="auto"><a name="isolate"></a><br>
-<code>--isolate </code><br>
+<code class="notranslate">--isolate </code><br>
This flag is highly recommended for high-coverage isolate and multi-cell Illumina data; improves the assembly quality and running time.<br>
We also recommend to trim your reads prior to the assembly. More details can be found <a href="http://cab.spbu.ru/benchmarking-tools-for-de-novo-microbial-assembly/" rel="nofollow">here</a>.<br>
-This option is not compatible with <code>--only-error-correction</code> or <code>--careful</code> options.</p>
+This option is not compatible with <code class="notranslate">--only-error-correction</code> or <code class="notranslate">--careful</code> options.</p>
<p dir="auto"><a name="sc"></a><br>
-<code>--sc </code><br>
+<code class="notranslate">--sc </code><br>
This flag is required for MDA (single-cell) data.</p>
<p dir="auto"><a href=""></a></p>
<p dir="auto"><a name="meta"></a><br>
-<code>--meta </code> (same as <code>metaspades.py</code>)<br>
-This flag is recommended when assembling metagenomic data sets (runs metaSPAdes, see <a href="https://genome.cshlp.org/content/27/5/824.short" rel="nofollow">paper</a> for more details). Currently metaSPAdes supports only a <strong><em>single</em></strong> short-read library which has to be <strong><em>paired-end</em></strong> (we hope to remove this restriction soon). In addition, you can provide long reads (e.g. using <code>--pacbio</code> or <code>--nanopore</code> options), but hybrid assembly for metagenomes remains an experimental pipeline and optimal performance is not guaranteed. It does not support <a href="#correctoropt">careful mode</a> (mismatch correction is not available). In addition, you cannot specify coverage cutoff for metaSPAdes. Note that metaSPAdes might be very sensitive to presence of the technical sequences remaining in the data (most notably adapter readthroughs), please run quality control and pre-process your data accordingly.</p>
+<code class="notranslate">--meta </code> (same as <code class="notranslate">metaspades.py</code>)<br>
+This flag is recommended when assembling metagenomic data sets (runs metaSPAdes, see <a href="https://genome.cshlp.org/content/27/5/824.short" rel="nofollow">paper</a> for more details). Currently metaSPAdes supports only a <strong><em>single</em></strong> short-read library which has to be <strong><em>paired-end</em></strong> (we hope to remove this restriction soon). In addition, you can provide long reads (e.g. using <code class="notranslate">--pacbio</code> or <code class="notranslate">--nanopore</code> options), but hybrid assembly for metagenomes remains an experimental pipeline and optimal performance is not guaranteed. It does not support <a href="#correctoropt">careful mode</a> (mismatch correction is not available). In addition, you cannot specify coverage cutoff for metaSPAdes. Note that metaSPAdes might be very sensitive to presence of the technical sequences remaining in the data (most notably adapter readthroughs), please run quality control and pre-process your data accordingly.</p>
<p dir="auto"><a href=""></a></p>
<p dir="auto"><a name="plasmid"></a><br>
-<code>--plasmid </code> (same as <code>plasmidspades.py</code>)<br>
+<code class="notranslate">--plasmid </code> (same as <code class="notranslate">plasmidspades.py</code>)<br>
This flag is required when assembling only plasmids from WGS data sets (runs plasmidSPAdes, see <a href="https://academic.oup.com/bioinformatics/article/32/22/3380/2525610" rel="nofollow">paper</a> for the algorithm details). Note, that plasmidSPAdes is not compatible with <a href="#sc">single-cell mode</a>. Additionally, we do not recommend to run plasmidSPAdes on more than one library.</p>
<p dir="auto">For plasmidSPAdes output details see <a href="#plasmidout">section 3.6</a>.</p>
<p dir="auto"><a href=""></a></p>
<p dir="auto"><a name="metaextrachromosomal"></a><br>
-<code>--metaplasmid </code> (same as <code>metaplasmidspades.py</code> and <code>--meta</code> <code>--plasmid</code>) and</p>
-<p dir="auto"><code>--metaviral </code> (same as <code>metaviralspades.py</code>)</p>
+<code class="notranslate">--metaplasmid </code> (same as <code class="notranslate">metaplasmidspades.py</code> and <code class="notranslate">--meta</code> <code class="notranslate">--plasmid</code>) and</p>
+<p dir="auto"><code class="notranslate">--metaviral </code> (same as <code class="notranslate">metaviralspades.py</code>)</p>
<p dir="auto">These options works specially for extracting extrachromosomal elements from metagenomic assemblies. They run similar pipelines that slightly differ in the simplification step; another difference is that for metaviral mode we output linear putative extrachromosomal contigs and for metaplasmid mode we do not.<br>
See <a href="https://genome.cshlp.org/content/29/6/961.short" rel="nofollow">metaplasmid paper</a> and <a href="https://academic.oup.com/bioinformatics/article-abstract/36/14/4126/5837667" rel="nofollow">metaviral paper</a> for the algorithms details.</p>
<p dir="auto">For metaplasmidSPAdes/metaviralSPAdes output details see <a href="#metapv">section 3.7</a>.</p>
@@ -314,138 +314,138 @@ See <a href="https://genome.cshlp.org/content/29/6/961.short" rel="nofollow">met
<p dir="auto">Additionally for plasmidSPAdes, metaplasmidSPAdes and metaviralSPAdes we recommend to additionally verify resulting contigs with <a href="https://github.com/ablab/viralVerify">viralVerify tool</a>.</p>
<p dir="auto"><a href=""></a></p>
<p dir="auto"><a name="biosynthetic"></a><br>
-<code>--bio </code><br>
+<code class="notranslate">--bio </code><br>
This flag is required when assembling only non-ribosomal and polyketide gene clusters from WGS data sets (runs biosyntheticSPAdes, see <a href="https://genome.cshlp.org/content/early/2019/06/03/gr.243477.118?top=1" rel="nofollow">paper</a> for the algorithm details). biosyntheticSPAdes is supposed to work on isolate or metagenomic WGS dataset. Note, that biosyntheticSPAdes is not compatible with any other modes. See <a href="#bgc">section 3.8</a> for biosyntheticSPAdes output details.</p>
<p dir="auto"><a href=""></a></p>
<p dir="auto"><a name="rna"></a><br>
-<code>--rna </code> (same as <code>rnaspades.py</code>)<br>
+<code class="notranslate">--rna </code> (same as <code class="notranslate">rnaspades.py</code>)<br>
This flag should be used when assembling RNA-Seq data sets (runs rnaSPAdes). To learn more, see <a href="rnaspades_manual.html">rnaSPAdes manual</a>.<br>
-Not compatible with <code>--only-error-correction</code> or <code>--careful</code> options.</p>
+Not compatible with <code class="notranslate">--only-error-correction</code> or <code class="notranslate">--careful</code> options.</p>
<p dir="auto"><a href=""></a></p>
<p dir="auto"><a name="rnaviral"></a><br>
-<code>--rnaviral</code> (same as <code>rnaviralspades.py</code>)<br>
+<code class="notranslate">--rnaviral</code> (same as <code class="notranslate">rnaviralspades.py</code>)<br>
This flag should be used when assembling viral RNA-Seq data sets (runs rnaviralSPAdes).<br>
-Not compatible with <code>--only-error-correction</code> or <code>--careful</code> options.</p>
-<p dir="auto"><code>--iontorrent </code><br>
+Not compatible with <code class="notranslate">--only-error-correction</code> or <code class="notranslate">--careful</code> options.</p>
+<p dir="auto"><code class="notranslate">--iontorrent </code><br>
This flag is required when assembling IonTorrent data. Allows BAM files as input. Carefully read <a href="#sec3.3">section 3.3</a> before using this option.</p>
-<p dir="auto"><code>--test</code><br>
+<p dir="auto"><code class="notranslate">--test</code><br>
Runs SPAdes on the toy data set; see <a href="#sec2.4">section 2.4</a>.</p>
-<p dir="auto"><code>-h</code> (or <code>--help</code>)<br>
+<p dir="auto"><code class="notranslate">-h</code> (or <code class="notranslate">--help</code>)<br>
Prints help.</p>
-<p dir="auto"><code>-v</code> (or <code>--version</code>)<br>
+<p dir="auto"><code class="notranslate">-v</code> (or <code class="notranslate">--version</code>)<br>
Prints SPAdes version.</p>
<p dir="auto"><a href=""></a><br>
<a name="pipelineopt"></a></p>
<h3 dir="auto">Pipeline options</h3>
-<p dir="auto"><code>--only-error-correction</code><br>
+<p dir="auto"><code class="notranslate">--only-error-correction</code><br>
Performs read error correction only.</p>
-<p dir="auto"><code>--only-assembler</code><br>
+<p dir="auto"><code class="notranslate">--only-assembler</code><br>
Runs assembly module only.</p>
<p dir="auto"><a href=""></a><br>
<a name="correctoropt"></a><br>
-<code>--careful</code><br>
+<code class="notranslate">--careful</code><br>
Tries to reduce the number of mismatches and short indels. Also runs MismatchCorrector - a post processing tool, which uses <a href="http://bio-bwa.sourceforge.net" rel="nofollow">BWA</a> tool (comes with SPAdes). This option is recommended only for assembly of small genomes. We strongly recommend not to use it for large and medium-size eukaryotic genomes. Note, that this options is is not supported by metaSPAdes and rnaSPAdes.</p>
-<p dir="auto"><code>--continue</code><br>
+<p dir="auto"><code class="notranslate">--continue</code><br>
Continues SPAdes run from the specified output folder starting from the last available check-point. Check-points are made after:</p>
<ul dir="auto">
<li>error correction module is finished</li>
<li>iteration for each specified K value of assembly module is finished</li>
<li>mismatch correction is finished for contigs or scaffolds</li>
</ul>
-<p dir="auto">For example, if specified K values are 21, 33 and 55 and SPAdes was stopped or crashed during assembly stage with K = 55, you can run SPAdes with the <code>--continue</code> option specifying the same output directory. SPAdes will continue the run starting from the assembly stage with K = 55. Error correction module and iterations for K equal to 21 and 33 will not be run again. If <code>--continue</code> is set, the only allowed option is <code>-o <output_dir> </code>.</p>
-<p dir="auto"><code>--restart-from <check_point></code><br>
+<p dir="auto">For example, if specified K values are 21, 33 and 55 and SPAdes was stopped or crashed during assembly stage with K = 55, you can run SPAdes with the <code class="notranslate">--continue</code> option specifying the same output directory. SPAdes will continue the run starting from the assembly stage with K = 55. Error correction module and iterations for K equal to 21 and 33 will not be run again. If <code class="notranslate">--continue</code> is set, the only allowed option is <code class="notranslate">-o <output_dir> </code>.</p>
+<p dir="auto"><code class="notranslate">--restart-from <check_point></code><br>
Restart SPAdes run from the specified output folder starting from the specified check-point. Check-points are:</p>
<ul dir="auto">
-<li><code>ec</code> - start from error correction</li>
-<li><code>as</code> - restart assembly module from the first iteration</li>
-<li><code>k<int></code> - restart from the iteration with specified k values, e.g. k55 (not available in RNA-Seq mode)</li>
-<li><code>mc</code> - restart mismatch correction</li>
-<li><code>last</code> - restart from the last available check-point (similar to <code>--continue</code>)</li>
+<li><code class="notranslate">ec</code> - start from error correction</li>
+<li><code class="notranslate">as</code> - restart assembly module from the first iteration</li>
+<li><code class="notranslate">k<int></code> - restart from the iteration with specified k values, e.g. k55 (not available in RNA-Seq mode)</li>
+<li><code class="notranslate">mc</code> - restart mismatch correction</li>
+<li><code class="notranslate">last</code> - restart from the last available check-point (similar to <code class="notranslate">--continue</code>)</li>
</ul>
-<p dir="auto">In contrast to the <code>--continue</code> option, you can change some of the options when using <code>--restart-from</code>. You can change any option except: all basic options, all options for specifying input data (including <code>--dataset</code>), <code>--only-error-correction</code> option and <code>--only-assembler</code> option. For example, if you ran assembler with k values 21,33,55 without mismatch correction, you can add one more iteration with k=77 and run mismatch correction step by running SPAdes with following options:<br>
-<code>--restart-from k55 -k 21,33,55,77 --mismatch-correction -o <previous_output_dir></code>.<br>
+<p dir="auto">In contrast to the <code class="notranslate">--continue</code> option, you can change some of the options when using <code class="notranslate">--restart-from</code>. You can change any option except: all basic options, all options for specifying input data (including <code class="notranslate">--dataset</code>), <code class="notranslate">--only-error-correction</code> option and <code class="notranslate">--only-assembler</code> option. For example, if you ran assembler with k values 21,33,55 without mismatch correction, you can add one more iteration with k=77 and run mismatch correction step by running SPAdes with following options:<br>
+<code class="notranslate">--restart-from k55 -k 21,33,55,77 --mismatch-correction -o <previous_output_dir></code>.<br>
Since all files will be overwritten, do not forget to copy your assembly from the previous run if you need it.</p>
-<p dir="auto"><code>--disable-gzip-output</code><br>
-Forces read error correction module not to compress the corrected reads. If this options is not set, corrected reads will be in <code>*.fastq.gz</code> format.</p>
+<p dir="auto"><code class="notranslate">--disable-gzip-output</code><br>
+Forces read error correction module not to compress the corrected reads. If this options is not set, corrected reads will be in <code class="notranslate">*.fastq.gz</code> format.</p>
<p dir="auto"><a href=""></a></p>
<p dir="auto"><a name="inputdata"></a></p>
<h3 dir="auto">Input data</h3>
<p dir="auto"><a name="inputdata:pairedend"></a></p>
<h4 dir="auto">Specifying single library (paired-end or single-read)</h4>
-<p dir="auto"><code>--12 <file_name> </code><br>
+<p dir="auto"><code class="notranslate">--12 <file_name> </code><br>
File with interlaced forward and reverse paired-end reads.</p>
-<p dir="auto"><code>-1 <file_name> </code><br>
+<p dir="auto"><code class="notranslate">-1 <file_name> </code><br>
File with forward reads.</p>
-<p dir="auto"><code>-2 <file_name> </code><br>
+<p dir="auto"><code class="notranslate">-2 <file_name> </code><br>
File with reverse reads.</p>
-<p dir="auto"><code>--merged <file_name> </code><br>
+<p dir="auto"><code class="notranslate">--merged <file_name> </code><br>
File with merged paired reads.<br>
If the properties of the library permit, overlapping paired-end reads can be merged using special software.<br>
Non-empty files with (remaining) unmerged left/right reads (separate or interlaced) <strong>must</strong> be provided for the same library for SPAdes to correctly detect the original read length.</p>
-<p dir="auto"><code>-s <file_name> </code><br>
+<p dir="auto"><code class="notranslate">-s <file_name> </code><br>
File with unpaired reads.</p>
<p dir="auto"><a name="inputdata:multiple"></a></p>
<h4 dir="auto">Specifying multiple libraries</h4>
<p dir="auto"><strong><em>Single-read libraries</em></strong></p>
-<p dir="auto"><code>--s<#> <file_name> </code><br>
-File for single-read library number <code><#></code> (<code><#></code> = 1,2,..,9). For example, for the first paired-end library the option is: <code>--s1 <file_name> </code><br>
-Do not use <code>-s</code> options for single-read libraries, since it specifies unpaired reads for the first paired-end library.</p>
+<p dir="auto"><code class="notranslate">--s<#> <file_name> </code><br>
+File for single-read library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9). For example, for the first paired-end library the option is: <code class="notranslate">--s1 <file_name> </code><br>
+Do not use <code class="notranslate">-s</code> options for single-read libraries, since it specifies unpaired reads for the first paired-end library.</p>
<p dir="auto"><strong><em>Paired-end libraries</em></strong></p>
-<p dir="auto"><code>--pe<#>-12 <file_name> </code><br>
-File with interlaced reads for paired-end library number <code><#></code> (<code><#></code> = 1,2,..,9). For example, for the first single-read library the option is: <code>--pe1-12 <file_name> </code></p>
-<p dir="auto"><code>--pe<#>-1 <file_name> </code><br>
-File with left reads for paired-end library number <code><#></code> (<code><#></code> = 1,2,..,9).</p>
-<p dir="auto"><code>--pe<#>-2 <file_name> </code><br>
-File with right reads for paired-end library number <code><#></code> (<code><#></code> = 1,2,..,9).</p>
-<p dir="auto"><code>--pe<#>-m <file_name> </code><br>
-File with merged reads from paired-end library number <code><#></code> (<code><#></code> = 1,2,..,9)<br>
+<p dir="auto"><code class="notranslate">--pe<#>-12 <file_name> </code><br>
+File with interlaced reads for paired-end library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9). For example, for the first single-read library the option is: <code class="notranslate">--pe1-12 <file_name> </code></p>
+<p dir="auto"><code class="notranslate">--pe<#>-1 <file_name> </code><br>
+File with left reads for paired-end library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9).</p>
+<p dir="auto"><code class="notranslate">--pe<#>-2 <file_name> </code><br>
+File with right reads for paired-end library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9).</p>
+<p dir="auto"><code class="notranslate">--pe<#>-m <file_name> </code><br>
+File with merged reads from paired-end library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9)<br>
If the properties of the library permit, paired reads can be merged using special software. Non-empty files with (remaining) unmerged left/right reads (separate or interlaced) <strong>must</strong> be provided for the same library for SPAdes to correctly detect the original read length.</p>
-<p dir="auto"><code>--pe<#>-s <file_name> </code><br>
-File with unpaired reads from paired-end library number <code><#></code> (<code><#></code> = 1,2,..,9)<br>
+<p dir="auto"><code class="notranslate">--pe<#>-s <file_name> </code><br>
+File with unpaired reads from paired-end library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9)<br>
For example, paired reads can become unpaired during the error correction procedure.</p>
-<p dir="auto"><code>--pe<#>-<or> </code><br>
-Orientation of reads for paired-end library number <code><#></code> (<code><#></code> = 1,2,..,9; <code><or></code> = "fr","rf","ff").<br>
-The default orientation for paired-end libraries is forward-reverse (<code>--> <--</code>). For example, to specify reverse-forward orientation for the second paired-end library, you should use the flag: <code>--pe2-rf </code><br>
+<p dir="auto"><code class="notranslate">--pe<#>-<or> </code><br>
+Orientation of reads for paired-end library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9; <code class="notranslate"><or></code> = "fr","rf","ff").<br>
+The default orientation for paired-end libraries is forward-reverse (<code class="notranslate">--> <--</code>). For example, to specify reverse-forward orientation for the second paired-end library, you should use the flag: <code class="notranslate">--pe2-rf </code><br>
Should not be confused with FR and RF strand-specificity for RNA-Seq data (see <a href="rnaspades_manual.html#sec2.3">rnaSPAdes manual</a>).</p>
<p dir="auto"><a name="inputdata:matepairs"></a><br>
<strong><em>Mate-pair libraries</em></strong></p>
-<p dir="auto"><code>--mp<#>-12 <file_name> </code><br>
-File with interlaced reads for mate-pair library number <code><#></code> (<code><#></code> = 1,2,..,9).</p>
-<p dir="auto"><code>--mp<#>-1 <file_name> </code><br>
-File with left reads for mate-pair library number <code><#></code> (<code><#></code> = 1,2,..,9).</p>
-<p dir="auto"><code>--mp<#>-2 <file_name> </code><br>
-File with right reads for mate-pair library number <code><#></code> (<code><#></code> = 1,2,..,9).</p>
-<p dir="auto"><code>--mp<#>-<or> </code><br>
-Orientation of reads for mate-pair library number <code><#></code> (<code><#></code> = 1,2,..,9; <code><or></code> = "fr","rf","ff").<br>
-The default orientation for mate-pair libraries is reverse-forward (<code><-- --></code>). For example, to specify forward-forward orientation for the first mate-pair library, you should use the flag: <code>--mp1-ff </code></p>
+<p dir="auto"><code class="notranslate">--mp<#>-12 <file_name> </code><br>
+File with interlaced reads for mate-pair library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9).</p>
+<p dir="auto"><code class="notranslate">--mp<#>-1 <file_name> </code><br>
+File with left reads for mate-pair library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9).</p>
+<p dir="auto"><code class="notranslate">--mp<#>-2 <file_name> </code><br>
+File with right reads for mate-pair library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9).</p>
+<p dir="auto"><code class="notranslate">--mp<#>-<or> </code><br>
+Orientation of reads for mate-pair library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9; <code class="notranslate"><or></code> = "fr","rf","ff").<br>
+The default orientation for mate-pair libraries is reverse-forward (<code class="notranslate"><-- --></code>). For example, to specify forward-forward orientation for the first mate-pair library, you should use the flag: <code class="notranslate">--mp1-ff </code></p>
<p dir="auto"><a name="hqmp"></a><br>
<strong><em>High-quality mate-pair libraries</em></strong> (can be used for mate-pair only assembly)</p>
-<p dir="auto"><code>--hqmp<#>-12 <file_name> </code><br>
-File with interlaced reads for high-quality mate-pair library number <code><#></code> (<code><#></code> = 1,2,..,9).</p>
-<p dir="auto"><code>--hqmp<#>-1 <file_name> </code><br>
-File with left reads for high-quality mate-pair library number <code><#></code> (<code><#></code> = 1,2,..,9).</p>
-<p dir="auto"><code>--hqmp<#>-2 <file_name> </code><br>
-File with right reads for high-quality mate-pair library number <code><#></code> (<code><#></code> = 1,2,..,9).</p>
-<p dir="auto"><code>--hqmp<#>-s <file_name> </code><br>
-File with unpaired reads from high-quality mate-pair library number <code><#></code> (<code><#></code> = 1,2,..,9)</p>
-<p dir="auto"><code>--hqmp<#>-<or> </code><br>
-Orientation of reads for high-quality mate-pair library number <code><#></code> (<code><#></code> = 1,2,..,9; <code><or></code> = "fr","rf","ff").<br>
-The default orientation for high-quality mate-pair libraries is forward-reverse (<code>--> <--</code>). For example, to specify reverse-forward orientation for the first high-quality mate-pair library, you should use the flag: <code>--hqmp1-rf </code></p>
+<p dir="auto"><code class="notranslate">--hqmp<#>-12 <file_name> </code><br>
+File with interlaced reads for high-quality mate-pair library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9).</p>
+<p dir="auto"><code class="notranslate">--hqmp<#>-1 <file_name> </code><br>
+File with left reads for high-quality mate-pair library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9).</p>
+<p dir="auto"><code class="notranslate">--hqmp<#>-2 <file_name> </code><br>
+File with right reads for high-quality mate-pair library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9).</p>
+<p dir="auto"><code class="notranslate">--hqmp<#>-s <file_name> </code><br>
+File with unpaired reads from high-quality mate-pair library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9)</p>
+<p dir="auto"><code class="notranslate">--hqmp<#>-<or> </code><br>
+Orientation of reads for high-quality mate-pair library number <code class="notranslate"><#></code> (<code class="notranslate"><#></code> = 1,2,..,9; <code class="notranslate"><or></code> = "fr","rf","ff").<br>
+The default orientation for high-quality mate-pair libraries is forward-reverse (<code class="notranslate">--> <--</code>). For example, to specify reverse-forward orientation for the first high-quality mate-pair library, you should use the flag: <code class="notranslate">--hqmp1-rf </code></p>
<p dir="auto"><a name="inputdata:longreads"></a><br>
<strong><em>Specifying data for hybrid assembly</em></strong></p>
-<p dir="auto"><code>--pacbio <file_name> </code><br>
-File with PacBio CLR reads. For PacBio CCS reads use <code>-s</code> option. More information on PacBio reads is provided in section 3.1.</p>
-<p dir="auto"><code>--nanopore <file_name> </code><br>
+<p dir="auto"><code class="notranslate">--pacbio <file_name> </code><br>
+File with PacBio CLR reads. For PacBio CCS reads use <code class="notranslate">-s</code> option. More information on PacBio reads is provided in section 3.1.</p>
+<p dir="auto"><code class="notranslate">--nanopore <file_name> </code><br>
File with Oxford Nanopore reads.</p>
-<p dir="auto"><code>--sanger <file_name> </code><br>
+<p dir="auto"><code class="notranslate">--sanger <file_name> </code><br>
File with Sanger reads</p>
-<p dir="auto"><code>--trusted-contigs <file_name> </code><br>
+<p dir="auto"><code class="notranslate">--trusted-contigs <file_name> </code><br>
Reliable contigs of the same genome, which are likely to have no misassemblies and small rate of other errors (e.g. mismatches and indels). This option is not intended for contigs of the related species.</p>
-<p dir="auto"><code>--untrusted-contigs <file_name> </code><br>
+<p dir="auto"><code class="notranslate">--untrusted-contigs <file_name> </code><br>
Contigs of the same genome, quality of which is average or unknown. Contigs of poor quality can be used but may introduce errors in the assembly. This option is also not intended for contigs of the related species.</p>
<p dir="auto"><strong><em>Other input</em></strong></p>
-<p dir="auto"><code>--assembly-graph <file_name> </code><br>
-File with assembly graph. Could only be used in plasmid, metaplasmid, metaviral and biosynthetic mode. The primary purpose of this option to run these pipelines on already constructed and simplified assembly graph this way skipping a large part of SPAdes pipeline. Original reads the graph was constructed from need to be specified as well. Exact k-mer length (via <code>-k</code> option) should be provided. Note that the output would be different as compared to standalone runs of these pipelines as they setup graph simplification options as well.</p>
+<p dir="auto"><code class="notranslate">--assembly-graph <file_name> </code><br>
+File with assembly graph. Could only be used in plasmid, metaplasmid, metaviral and biosynthetic mode. The primary purpose of this option to run these pipelines on already constructed and simplified assembly graph this way skipping a large part of SPAdes pipeline. Original reads the graph was constructed from need to be specified as well. Exact k-mer length (via <code class="notranslate">-k</code> option) should be provided. Note that the output would be different as compared to standalone runs of these pipelines as they setup graph simplification options as well.</p>
<p dir="auto"><a name="inputdata:yaml"></a><br>
<strong><em>Specifying input data with YAML data set file (advanced)</em></strong></p>
<p dir="auto">An alternative way to specify an input data set for SPAdes is to create a <a href="http://www.yaml.org/" rel="nofollow">YAML</a> data set file. By using a YAML file you can provide an unlimited number of paired-end, mate-pair and unpaired libraries. Basically, YAML data set file is a text file, in which input libraries are provided as a comma-separated list in square brackets. Each library is provided in braces as a comma-separated list of attributes. The following attributes are available:</p>
@@ -508,33 +508,33 @@ File with assembly graph. Could only be used in plasmid, metaplasmid, metaviral
]
}
]</pre></div>
-<p dir="auto">Once you have created a YAML file save it with <code>.yaml</code> extension (e.g. as <code>my_data_set.yaml</code>) and run SPAdes using the <code>--dataset</code> option:<br>
-<code>--dataset <your YAML file></code><br>
+<p dir="auto">Once you have created a YAML file save it with <code class="notranslate">.yaml</code> extension (e.g. as <code class="notranslate">my_data_set.yaml</code>) and run SPAdes using the <code class="notranslate">--dataset</code> option:<br>
+<code class="notranslate">--dataset <your YAML file></code><br>
Notes:</p>
<ul dir="auto">
-<li>The <code>--dataset</code> option cannot be used with any other options for specifying input data.</li>
+<li>The <code class="notranslate">--dataset</code> option cannot be used with any other options for specifying input data.</li>
<li>We recommend to nest all files with long reads of the same data type in a single library block.</li>
</ul>
<p dir="auto"><a href=""></a></p>
<p dir="auto"><a name="advancedopt"></a></p>
<h3 dir="auto">Advanced options</h3>
-<p dir="auto"><code>-t <int></code> (or <code>--threads <int></code>)<br>
+<p dir="auto"><code class="notranslate">-t <int></code> (or <code class="notranslate">--threads <int></code>)<br>
Number of threads. The default value is 16.</p>
-<p dir="auto"><code>-m <int></code> (or <code>--memory <int></code>)<br>
+<p dir="auto"><code class="notranslate">-m <int></code> (or <code class="notranslate">--memory <int></code>)<br>
Set memory limit in Gb. SPAdes terminates if it reaches this limit. The default value is 250 Gb. Actual amount of consumed RAM will be below this limit. Make sure this value is correct for the given machine. SPAdes uses the limit value to automatically determine the sizes of various buffers, etc.</p>
-<p dir="auto"><code>--tmp-dir <dir_name></code><br>
-Set directory for temporary files from read error correction. The default value is <code><output_dir>/corrected/tmp</code></p>
-<p dir="auto"><code>-k <int,int,...></code><br>
-Comma-separated list of k-mer sizes to be used (all values must be odd, less than 128 and listed in ascending order). If <code>--sc</code> is set the default values are 21,33,55. For multicell data sets K values are automatically selected using maximum read length (<a href="#sec3.4">see note for assembling long Illumina paired reads for details</a>). To properly select K values for IonTorrent data read <a href="#sec3.3">section 3.3</a>.</p>
-<p dir="auto"><code>--cov-cutoff <float></code><br>
+<p dir="auto"><code class="notranslate">--tmp-dir <dir_name></code><br>
+Set directory for temporary files from read error correction. The default value is <code class="notranslate"><output_dir>/corrected/tmp</code></p>
+<p dir="auto"><code class="notranslate">-k <int,int,...></code><br>
+Comma-separated list of k-mer sizes to be used (all values must be odd, less than 128 and listed in ascending order). If <code class="notranslate">--sc</code> is set the default values are 21,33,55. For multicell data sets K values are automatically selected using maximum read length (<a href="#sec3.4">see note for assembling long Illumina paired reads for details</a>). To properly select K values for IonTorrent data read <a href="#sec3.3">section 3.3</a>.</p>
+<p dir="auto"><code class="notranslate">--cov-cutoff <float></code><br>
Read coverage cutoff value. Must be a positive float value, or "auto", or "off". Default value is "off". When set to "auto" SPAdes automatically computes coverage threshold using conservative strategy. Note, that this option is not supported by metaSPAdes.</p>
-<p dir="auto"><code>--phred-offset <33 or 64></code><br>
+<p dir="auto"><code class="notranslate">--phred-offset <33 or 64></code><br>
PHRED quality offset for the input reads, can be either 33 or 64. It will be auto-detected if it is not specified.</p>
-<p dir="auto"><code>--custom-hmms <file or directory></code><br>
+<p dir="auto"><code class="notranslate">--custom-hmms <file or directory></code><br>
File or directory with amino acid HMMs for <a href="#hmm">HMM-guided mode</a>.</p>
<p dir="auto"><a name="examples"></a></p>
<h3 dir="auto">Examples</h3>
-<p dir="auto">To test the toy data set, you can also run the following command from the SPAdes <code>bin</code> directory:</p>
+<p dir="auto">To test the toy data set, you can also run the following command from the SPAdes <code class="notranslate">bin</code> directory:</p>
<div class="highlight highlight-source-shell"><pre> spades.py --pe1-1 ../share/spades/test_dataset/ecoli_1K_1.fq.gz \
--pe1-2 ../share/spades/test_dataset/ecoli_1K_2.fq.gz -o spades_test</pre></div>
<p dir="auto">If you have your library separated into several pairs of files, for example:</p>
@@ -585,9 +585,9 @@ File or directory with amino acid HMMs for <a href="#hmm">HMM-guided mode</a>.</
<p dir="auto"><a name="sec3.3"></a></p>
<h2 dir="auto">Assembling IonTorrent reads</h2>
<p dir="auto">Only FASTQ or BAM files are supported as input.</p>
-<p dir="auto">The selection of k-mer length is non-trivial for IonTorrent. If the dataset is more or less conventional (good coverage, not high GC, etc), then use our <a href="#sec3.4">recommendation for long reads</a> (e.g. assemble using k-mer lengths 21,33,55,77,99,127). However, due to increased error rate some changes of k-mer lengths (e.g. selection of shorter ones) may be required. For example, if you ran SPAdes with k-mer lengths 21,33,55,77 and then decided to assemble the same data set using more iterations and larger values of K, you can run SPAdes once again specifying the same output folder and the following options: <code>--restart-from k77 -k 21,33,55,77,99,127 --mismatch-correction -o <previous_output_dir></code>. Do not forget to copy contigs and scaffolds from the previous run. We are planning to tackle issue of selecting k-mer lengths for IonTorrent reads in next versions.</p>
+<p dir="auto">The selection of k-mer length is non-trivial for IonTorrent. If the dataset is more or less conventional (good coverage, not high GC, etc), then use our <a href="#sec3.4">recommendation for long reads</a> (e.g. assemble using k-mer lengths 21,33,55,77,99,127). However, due to increased error rate some changes of k-mer lengths (e.g. selection of shorter ones) may be required. For example, if you ran SPAdes with k-mer lengths 21,33,55,77 and then decided to assemble the same data set using more iterations and larger values of K, you can run SPAdes once again specifying the same output folder and the following options: <code class="notranslate">--restart-from k77 -k 21,33,55,77,99,127 --mismatch-correction -o <previous_output_dir></code>. Do not forget to copy contigs and scaffolds from the previous run. We are planning to tackle issue of selecting k-mer lengths for IonTorrent reads in next versions.</p>
<p dir="auto">You may need no error correction for Hi-Q enzyme at all. However, we suggest trying to assemble your data with and without error correction and select the best variant.</p>
-<p dir="auto">For non-trivial datasets (e.g. with high GC, low or uneven coverage) we suggest to enable single-cell mode (setting <code>--sc</code> option) and use k-mer lengths of 21,33,55. <a href=""></a></p>
+<p dir="auto">For non-trivial datasets (e.g. with high GC, low or uneven coverage) we suggest to enable single-cell mode (setting <code class="notranslate">--sc</code> option) and use k-mer lengths of 21,33,55. <a href=""></a></p>
<p dir="auto"><a name="sec3.4"></a><br>
<a name="illumina_long"></a></p>
<h2 dir="auto">Assembling long Illumina paired reads (2x150 and 2x250)</h2>
@@ -598,7 +598,7 @@ File or directory with amino acid HMMs for <a href="#hmm">HMM-guided mode</a>.</
<h3 dir="auto">Multi-cell data set with read length 2x150 bp</h3>
<p dir="auto">Do not turn off SPAdes error correction (BayesHammer module), which is included in SPAdes default pipeline.</p>
<p dir="auto">If you have enough coverage (50x+), then you may want to try to set k-mer lengths of 21, 33, 55, 77 (selected by default for reads with length 150bp).</p>
-<p dir="auto">Make sure you run assembler with the <code>--careful</code> option to minimize number of mismatches in the final contigs.</p>
+<p dir="auto">Make sure you run assembler with the <code class="notranslate">--careful</code> option to minimize number of mismatches in the final contigs.</p>
<p dir="auto">We recommend that you check the SPAdes log file at the end of the each iteration to control the average coverage of the contigs.</p>
<p dir="auto">For reads corrected prior to running the assembler:</p>
<div class="highlight highlight-source-shell"><pre> spades.py -k 21,33,55,77 --careful --only-assembler <span class="pl-k"><</span>your reads<span class="pl-k">></span> -o spades_output</pre></div>
@@ -608,7 +608,7 @@ File or directory with amino acid HMMs for <a href="#hmm">HMM-guided mode</a>.</
<h3 dir="auto">Multi-cell data set with read lengths 2x250 bp</h3>
<p dir="auto">Do not turn off SPAdes error correction (BayesHammer module), which is included in SPAdes default pipeline.</p>
<p dir="auto">By default we suggest to increase k-mer lengths in increments of 22 until the k-mer length reaches 127. The exact length of the k-mer depends on the coverage: k-mer length of 127 corresponds to 50x k-mer coverage and higher. For read length 250bp SPAdes automatically chooses K values equal to 21, 33, 55, 77, 99, 127.</p>
-<p dir="auto">Make sure you run assembler with <code>--careful</code> option to minimize number of mismatches in the final contigs.</p>
+<p dir="auto">Make sure you run assembler with <code class="notranslate">--careful</code> option to minimize number of mismatches in the final contigs.</p>
<p dir="auto">We recommend you to check the SPAdes log file at the end of the each iteration to control the average coverage of the contigs.</p>
<p dir="auto">For reads corrected prior to running the assembler:</p>
<div class="highlight highlight-source-shell"><pre> spades.py -k 21,33,55,77,99,127 --careful --only-assembler <span class="pl-k"><</span>your reads<span class="pl-k">></span> -o spades_output</pre></div>
@@ -622,50 +622,50 @@ File or directory with amino acid HMMs for <a href="#hmm">HMM-guided mode</a>.</
<p dir="auto"><a name="hmm"></a></p>
<h2 dir="auto">HMM-guided mode</h2>
<p dir="auto">The majority of SPAdes assembly modes (normal multicell, single-cell, rnaviral, meta and of course biosynthetic) also supports HMM-guided mode as implemented in biosyntheticSPAdes. The detailed description could be found in <a href="https://genome.cshlp.org/content/early/2019/06/03/gr.243477.118" rel="nofollow">biosyntheticSPAdes paper</a>, but in short: amino acid profile HMMs are aligned to the edges of assembly graph. After this the subgraphs containing the set of matches ("domains") are extracted and all possible paths through the domains that are supported both by paired-end data (via scaffolds) and graph topology are obtained (putative biosynthetic gene clusters).</p>
-<p dir="auto">HMM-guided mode could be enabled via providing a set of HMMs via <code>--custom-hmms</code> option. In HMM guided mode the set of contigs and scaffolds (see section <a href="#spadesoutput">SPAdes output</a> for more information about SPAdes output) is kept intact, however additional <a href="#bgc">biosyntheticSPAdes output</a> represents the output of HMM-guided assembly.</p>
-<p dir="auto">Note that normal biosyntheticSPAdes mode (via <code>--bio</code> option) is a bit different from HMM-guided mode: besides using the special set of profile HMMS representing a family of NRSP/PKS domains also includes a set of assembly graph simplification and processing settings aimed for fuller recovery of biosynthetic gene clusters.</p>
-<p dir="auto">Given an increased interest in coronavirus research we developed a coronavirus assembly mode for SPAdes assembler (also known as coronaSPAdes). It allows to assemble full-length coronaviridae genomes from the transcriptomic and metatranscriptomic data. Algorithmically, coronaSPAdes is an rnaviralSPAdes that uses the set of HMMs from Pfam SARS-CoV-2 2.0 set as well as additional HMMs as outlined by <a href="https://doi.org/10.1093/ve/vey035" rel="nofollow">(Phan et al, 2019)</a>. coronaSPAdes could be run via a dedicated <code>coronaspades.py</code> script. See <a href="https://www.biorxiv.org/content/10.1101/2020.07.28.224584v1" rel="nofollow">coronaSPAdes preprint</a> for more information about rnaviralSPAdes, coronaSPAdes and HMM-guided mode. Output for any HMM-related mode (--bio, --corona, or --custom-hmms flags) is the same with biosyntheticSPAdes' output.</p>
+<p dir="auto">HMM-guided mode could be enabled via providing a set of HMMs via <code class="notranslate">--custom-hmms</code> option. In HMM guided mode the set of contigs and scaffolds (see section <a href="#spadesoutput">SPAdes output</a> for more information about SPAdes output) is kept intact, however additional <a href="#bgc">biosyntheticSPAdes output</a> represents the output of HMM-guided assembly.</p>
+<p dir="auto">Note that normal biosyntheticSPAdes mode (via <code class="notranslate">--bio</code> option) is a bit different from HMM-guided mode: besides using the special set of profile HMMS representing a family of NRSP/PKS domains also includes a set of assembly graph simplification and processing settings aimed for fuller recovery of biosynthetic gene clusters.</p>
+<p dir="auto">Given an increased interest in coronavirus research we developed a coronavirus assembly mode for SPAdes assembler (also known as coronaSPAdes). It allows to assemble full-length coronaviridae genomes from the transcriptomic and metatranscriptomic data. Algorithmically, coronaSPAdes is an rnaviralSPAdes that uses the set of HMMs from Pfam SARS-CoV-2 2.0 set as well as additional HMMs as outlined by <a href="https://doi.org/10.1093/ve/vey035" rel="nofollow">(Phan et al, 2019)</a>. coronaSPAdes could be run via a dedicated <code class="notranslate">coronaspades.py</code> script. See <a href="https://www.biorxiv.org/content/10.1101/2020.07.28.224584v1" rel="nofollow">coronaSPAdes preprint</a> for more information about rnaviralSPAdes, coronaSPAdes and HMM-guided mode. Output for any HMM-related mode (--bio, --corona, or --custom-hmms flags) is the same with biosyntheticSPAdes' output.</p>
<p dir="auto"><a name="spadesoutput"></a></p>
<h2 dir="auto">SPAdes output</h2>
-<p dir="auto">SPAdes stores all output files in <code><output_dir> </code>, which is set by the user.</p>
+<p dir="auto">SPAdes stores all output files in <code class="notranslate"><output_dir> </code>, which is set by the user.</p>
<ul dir="auto">
-<li><code><output_dir>/corrected/</code> directory contains reads corrected by BayesHammer in <code>*.fastq.gz</code> files; if compression is disabled, reads are stored in uncompressed <code>*.fastq</code> files</li>
-<li><code><output_dir>/scaffolds.fasta</code> contains resulting scaffolds (recommended for use as resulting sequences)</li>
-<li><code><output_dir>/contigs.fasta</code> contains resulting contigs</li>
-<li><code><output_dir>/assembly_graph_with_scaffolds.gfa</code> contains SPAdes assembly graph and scaffolds paths in <a href="https://github.com/GFA-spec/GFA-spec/blob/master/GFA1.md">GFA 1.0 format</a></li>
-<li><code><output_dir>/assembly_graph.fastg</code> contains SPAdes assembly graph in <a href="http://fastg.sourceforge.net/FASTG_Spec_v1.00.pdf" rel="nofollow">FASTG format</a></li>
-<li><code><output_dir>/contigs.paths</code> contains paths in the assembly graph corresponding to contigs.fasta (see details below)</li>
-<li><code><output_dir>/scaffolds.paths</code> contains paths in the assembly graph corresponding to scaffolds.fasta (see details below)</li>
+<li><code class="notranslate"><output_dir>/corrected/</code> directory contains reads corrected by BayesHammer in <code class="notranslate">*.fastq.gz</code> files; if compression is disabled, reads are stored in uncompressed <code class="notranslate">*.fastq</code> files</li>
+<li><code class="notranslate"><output_dir>/scaffolds.fasta</code> contains resulting scaffolds (recommended for use as resulting sequences)</li>
+<li><code class="notranslate"><output_dir>/contigs.fasta</code> contains resulting contigs</li>
+<li><code class="notranslate"><output_dir>/assembly_graph_with_scaffolds.gfa</code> contains SPAdes assembly graph and scaffolds paths in <a href="https://github.com/GFA-spec/GFA-spec/blob/master/GFA1.md">GFA 1.0 format</a></li>
+<li><code class="notranslate"><output_dir>/assembly_graph.fastg</code> contains SPAdes assembly graph in <a href="http://fastg.sourceforge.net/FASTG_Spec_v1.00.pdf" rel="nofollow">FASTG format</a></li>
+<li><code class="notranslate"><output_dir>/contigs.paths</code> contains paths in the assembly graph corresponding to contigs.fasta (see details below)</li>
+<li><code class="notranslate"><output_dir>/scaffolds.paths</code> contains paths in the assembly graph corresponding to scaffolds.fasta (see details below)</li>
</ul>
<p dir="auto"><a name="spadesoutput:contigs"></a></p>
<h3 dir="auto">Contigs and scaffolds format</h3>
<p dir="auto">Contigs/scaffolds names in SPAdes output FASTA files have the following format:<br>
-<code>>NODE_3_length_237403_cov_243.207</code><br>
-Here <code>3</code> is the number of the contig/scaffold, <code>237403</code> is the sequence length in nucleotides and <code>243.207</code> is the k-mer coverage for the last (largest) k value used. Note that the k-mer coverage is always lower than the read (per-base) coverage.</p>
+<code class="notranslate">>NODE_3_length_237403_cov_243.207</code><br>
+Here <code class="notranslate">3</code> is the number of the contig/scaffold, <code class="notranslate">237403</code> is the sequence length in nucleotides and <code class="notranslate">243.207</code> is the k-mer coverage for the last (largest) k value used. Note that the k-mer coverage is always lower than the read (per-base) coverage.</p>
<p dir="auto">In general, SPAdes uses two techniques for joining contigs into scaffolds. First one relies on read pairs and tries to estimate the size of the gap separating contigs. The second one relies on the assembly graph: e.g. if two contigs are separated by a complex tandem repeat, that cannot be resolved exactly, contigs are joined into scaffold with a fixed gap size of 100 bp. Contigs produced by SPAdes do not contain N symbols.</p>
<p dir="auto"><a name="spadesoutput:graph"></a></p>
<h3 dir="auto">Assembly graph formats</h3>
-<p dir="auto">To view FASTG and GFA files we recommend to use <a href="http://rrwick.github.io/Bandage/" rel="nofollow">Bandage visualization tool</a>. Note that sequences stored in <code>assembly_graph.fastg</code> correspond to contigs before repeat resolution (edges of the assembly graph). Paths corresponding to contigs after repeat resolution (scaffolding) are stored in <code>contigs.paths</code> (<code>scaffolds.paths</code>) in the format accepted by Bandage (see <a href="https://github.com/rrwick/Bandage/wiki/Graph-paths">Bandage wiki</a> for details). The example is given below.</p>
-<p dir="auto">Let the contig with the name <code>NODE_5_length_100000_cov_215.651</code> consist of the following edges of the assembly graph:</p>
-<pre lang="plain"><code> >EDGE_2_length_33280_cov_199.702
+<p dir="auto">To view FASTG and GFA files we recommend to use <a href="http://rrwick.github.io/Bandage/" rel="nofollow">Bandage visualization tool</a>. Note that sequences stored in <code class="notranslate">assembly_graph.fastg</code> correspond to contigs before repeat resolution (edges of the assembly graph). Paths corresponding to contigs after repeat resolution (scaffolding) are stored in <code class="notranslate">contigs.paths</code> (<code class="notranslate">scaffolds.paths</code>) in the format accepted by Bandage (see <a href="https://github.com/rrwick/Bandage/wiki/Graph-paths">Bandage wiki</a> for details). The example is given below.</p>
+<p dir="auto">Let the contig with the name <code class="notranslate">NODE_5_length_100000_cov_215.651</code> consist of the following edges of the assembly graph:</p>
+<pre lang="plain" class="notranslate"><code class="notranslate"> >EDGE_2_length_33280_cov_199.702
>EDGE_5_length_84_cov_321.414"
>EDGE_3_length_111_cov_175.304
>EDGE_5_length_84_cov_321.414"
>EDGE_4_length_66661_cov_223.548
</code></pre>
-<p dir="auto">Then, <code>contigs.paths</code> will contain the following record:</p>
-<pre lang="plain"><code> NODE_5_length_100000_cov_215.651
+<p dir="auto">Then, <code class="notranslate">contigs.paths</code> will contain the following record:</p>
+<pre lang="plain" class="notranslate"><code class="notranslate"> NODE_5_length_100000_cov_215.651
2+,5-,3+,5-,4+
</code></pre>
<p dir="auto">Since the current version of Bandage does not accept paths with gaps, paths corresponding contigs/scaffolds jumping over a gap in the assembly graph are split by semicolon at the gap positions. For example, the following record</p>
-<pre lang="plain"><code> NODE_3_length_237403_cov_243.207
+<pre lang="plain" class="notranslate"><code class="notranslate"> NODE_3_length_237403_cov_243.207
21-,17-,15+,17-,16+;
31+,23-,22+,23-,4-
</code></pre>
-<p dir="auto">states that <code>NODE_3_length_237403_cov_243.207</code> corresponds to the path with 10 edges, but jumps over a gap between edges <code>EDGE_16_length_21503_cov_482.709</code> and <code>EDGE_31_length_140767_cov_220.239</code>.</p>
+<p dir="auto">states that <code class="notranslate">NODE_3_length_237403_cov_243.207</code> corresponds to the path with 10 edges, but jumps over a gap between edges <code class="notranslate">EDGE_16_length_21503_cov_482.709</code> and <code class="notranslate">EDGE_31_length_140767_cov_220.239</code>.</p>
<p dir="auto"><a name="spadesoutput:full"></a></p>
<h3 dir="auto">Complete list of output files</h3>
-<p dir="auto">The full list of <code><output_dir></code> content is presented below:</p>
+<p dir="auto">The full list of <code class="notranslate"><output_dir></code> content is presented below:</p>
<ul dir="auto">
<li>
<p dir="auto">scaffolds.fasta - resulting scaffolds (recommended for use as resulting sequences)</p>
@@ -709,18 +709,18 @@ Here <code>3</code> is the number of the contig/scaffold, <code>237403</code> is
<p dir="auto">K<##>/ - directory containing intermediate files from the run with K=<##>. These files should not be used as assembly results; use resulting contigs/scaffolds in files mentioned above.</p>
</li>
</ul>
-<p dir="auto">SPAdes will overwrite these files and directories if they exist in the specified <code><output_dir></code>. <a href=""></a></p>
+<p dir="auto">SPAdes will overwrite these files and directories if they exist in the specified <code class="notranslate"><output_dir></code>. <a href=""></a></p>
<p dir="auto"><a name="plasmidout"></a></p>
<h2 dir="auto">plasmidSPAdes output</h2>
<p dir="auto">plasmidSPAdes and metaplasmidSPAdes output only DNA sequences from putative plasmids. Output file names and formats remain the same as in SPAdes (see <a href="#spadesoutput">previous</a> section), with the following differences.</p>
-<p dir="auto">For all plasmidSPAdes' contig names in <code>contigs.fasta</code>, <code>scaffolds.fasta</code> and <code>assembly_graph.fastg</code> we append suffix <code>_component_X</code>, where <code>X</code> is the id of the putative plasmid, which the contig belongs to. Note that plasmidSPAdes may not be able to separate similar plasmids and thus their contigs may appear with the same id. <a href=""></a></p>
+<p dir="auto">For all plasmidSPAdes' contig names in <code class="notranslate">contigs.fasta</code>, <code class="notranslate">scaffolds.fasta</code> and <code class="notranslate">assembly_graph.fastg</code> we append suffix <code class="notranslate">_component_X</code>, where <code class="notranslate">X</code> is the id of the putative plasmid, which the contig belongs to. Note that plasmidSPAdes may not be able to separate similar plasmids and thus their contigs may appear with the same id. <a href=""></a></p>
<p dir="auto"><a name="metapv"></a></p>
<h2 dir="auto">metaplasmidSPAdes/metaviralSPAdes output</h2>
-<p dir="auto">The repeat resolution and extrachromosomal element detection in metaplasmidSPAdes/metaviralSPAdes is run independently for different coverage cutoffs values (see <a href="https://genome.cshlp.org/content/29/6/961.short" rel="nofollow">paper</a> for details). In order to distinguish contigs with putative plasmids detected at different cutoff levels we extend the contig name in FASTA file with cutoff value used for this particular contig (in format <code>_cutoff_N</code>). This is why, in the contrast to regular SPAdes pipeline, there might be a contig with <code>NODE_1_</code> prefix for each cutoff with potential plasmids detected. In following example, there were detected two potential viruses using cutoff 0, one virus was detected with cutoff 5 and one with cutoff 10.<br>
+<p dir="auto">The repeat resolution and extrachromosomal element detection in metaplasmidSPAdes/metaviralSPAdes is run independently for different coverage cutoffs values (see <a href="https://genome.cshlp.org/content/29/6/961.short" rel="nofollow">paper</a> for details). In order to distinguish contigs with putative plasmids detected at different cutoff levels we extend the contig name in FASTA file with cutoff value used for this particular contig (in format <code class="notranslate">_cutoff_N</code>). This is why, in the contrast to regular SPAdes pipeline, there might be a contig with <code class="notranslate">NODE_1_</code> prefix for each cutoff with potential plasmids detected. In following example, there were detected two potential viruses using cutoff 0, one virus was detected with cutoff 5 and one with cutoff 10.<br>
Also, we add a suffix that shows the structure of the suspective extrachromosomal element.<br>
For metaplasmid mode we output only circular putative plasmids.<br>
For metaviral mode we also output linear putative viruses and linear viruses with simple repeats ('9'-shaped components in the assembly graph) sequences.</p>
-<pre lang="plain"><code>>NODE_1_length_40003_cov_13.48_cutoff_0_type_circular
+<pre lang="plain" class="notranslate"><code class="notranslate">>NODE_1_length_40003_cov_13.48_cutoff_0_type_circular
>NODE_2_length_30000_cov_4.20_cutoff_0_type_linear
>NODE_1_length_20000_cov_20.42_cutoff_5_type_circular
>NODE_1_length_10000_cov_198.4_cutoff_10_type_linearrepeat
@@ -729,7 +729,7 @@ For metaviral mode we also output linear putative viruses and linear viruses wit
<h2 dir="auto">biosyntheticSPAdes output</h2>
<p dir="auto">biosyntheticSPAdes outputs four files of interest:</p>
<ul dir="auto">
-<li>scaffolds.fasta – contains DNA sequences from putative biosynthetic gene clusters (BGC). Since each sample may contain multiple BGCs and biosyntheticSPAdes can output several putative DNA sequences for eash cluster, for each contig name we append suffix <code>_cluster_X_candidate_Y</code>, where X is the id of the BGC and Y is the id of the candidate from the BGC.</li>
+<li>scaffolds.fasta – contains DNA sequences from putative biosynthetic gene clusters (BGC). Since each sample may contain multiple BGCs and biosyntheticSPAdes can output several putative DNA sequences for eash cluster, for each contig name we append suffix <code class="notranslate">_cluster_X_candidate_Y</code>, where X is the id of the BGC and Y is the id of the candidate from the BGC.</li>
<li>raw_scaffolds.fasta – SPAdes scaffolds generated without domain-graph related algorithms. Very close to regular scaffolds.fasta file.</li>
<li>hmm_statistics.txt – contains statistics about BGC composition in the sample. First, it outputs number of domain hits in the sample. Then, for each BGC candidate we output domain order with positions on the corresponding DNA sequence from scaffolds.fasta.</li>
<li>domain_graph.dot – contains domain graph structure, that can be used to assess complexity of the sample and structure of BGCs. For more information about domain graph construction, please refer to the paper.</li>
@@ -742,7 +742,7 @@ For metaviral mode we also output linear putative viruses and linear viruses wit
<h1 dir="auto">Stand-alone binaries released within SPAdes package</h1>
<p dir="auto"><a name="sec4.1"></a></p>
<h2 dir="auto">k-mer counting</h2>
-<p dir="auto">To provide input data to SPAdes k-mer counting tool <code>spades-kmercounter </code> you may just specify files in <a href="#sec3.1">SPAdes-supported formats</a> without any flags (after all options) or provide dataset description file in YAML format.</p>
+<p dir="auto">To provide input data to SPAdes k-mer counting tool <code class="notranslate">spades-kmercounter </code> you may just specify files in <a href="#sec3.1">SPAdes-supported formats</a> without any flags (after all options) or provide dataset description file in YAML format.</p>
<p dir="auto">Output: <output_dir>/final_kmers - unordered set of kmers in binary format. Kmers from both forward a<br>
nd reverse-complementary reads are taken into account.</p>
<p dir="auto">Output format: All kmers are written sequentially without any separators. Each kmer takes the same nu<br>
@@ -750,7 +750,7 @@ mber of bits. One kmer of length K takes 2*K bits. Kmers are aligned by 64 bits.
r with length=21 takes 8 bytes, with length=33 takes 16 bytes, and with length=55 takes 16 bytes. Eac<br>
h nucleotide is coded with 2 bits: 00 - A, 01 - C, 10 - G, 11 - T.</p>
<p dir="auto">Example:</p>
-<pre><code> For kmer: AGCTCT
+<pre class="notranslate"><code class="notranslate"> For kmer: AGCTCT
Memory: 6 bits * 2 = 12, 64 bits (8 bytes)
Let’s describe bytes:
data[0] = AGCT -> 11 01 10 00 -> 0xd8
@@ -762,103 +762,103 @@ h nucleotide is coded with 2 bits: 00 - A, 01 - C, 10 - G, 11 - T.</p>
data[6] = 0000 -> 00 00 00 00 -> 0x00
data[7] = 0000 -> 00 00 00 00 -> 0x00
</code></pre>
-<p dir="auto">Synopsis: <code>spades-kmercount [OPTION...] <input files></code></p>
+<p dir="auto">Synopsis: <code class="notranslate">spades-kmercount [OPTION...] <input files></code></p>
<p dir="auto">The options are:</p>
-<p dir="auto"><code>-d, --dataset file <file name> </code><br>
+<p dir="auto"><code class="notranslate">-d, --dataset file <file name> </code><br>
dataset description (in YAML format), input files ignored</p>
-<p dir="auto"><code>-k, --kmer <int> </code><br>
+<p dir="auto"><code class="notranslate">-k, --kmer <int> </code><br>
k-mer length (default: 21)</p>
-<p dir="auto"><code>-t, --threads <int> </code><br>
+<p dir="auto"><code class="notranslate">-t, --threads <int> </code><br>
number of threads to use (default: number of CPUs)</p>
-<p dir="auto"><code>-w, --workdir <dir name> </code><br>
+<p dir="auto"><code class="notranslate">-w, --workdir <dir name> </code><br>
working directory to use (default: current directory)</p>
-<p dir="auto"><code>-b, --bufsize <int> </code><br>
+<p dir="auto"><code class="notranslate">-b, --bufsize <int> </code><br>
sorting buffer size in bytes, per thread (default 536870912)</p>
-<p dir="auto"><code>-h, --help </code><br>
+<p dir="auto"><code class="notranslate">-h, --help </code><br>
print help message</p>
<p dir="auto"><a name="sec4.2"></a></p>
<h2 dir="auto">k-mer coverage read filter</h2>
-<p dir="auto"><code>spades-read-filter</code> is a tool for filtering reads with median kmer coverage less than threshold.</p>
-<p dir="auto">To provide input data to SPAdes k-mer read filter tool <code>spades-read-filter </code> you should provide dataset description file in YAML format.</p>
-<p dir="auto">Synopsis: <code>spades-read-filter [OPTION...] -d <yaml></code></p>
+<p dir="auto"><code class="notranslate">spades-read-filter</code> is a tool for filtering reads with median kmer coverage less than threshold.</p>
+<p dir="auto">To provide input data to SPAdes k-mer read filter tool <code class="notranslate">spades-read-filter </code> you should provide dataset description file in YAML format.</p>
+<p dir="auto">Synopsis: <code class="notranslate">spades-read-filter [OPTION...] -d <yaml></code></p>
<p dir="auto">The options are:</p>
-<p dir="auto"><code>-d, --dataset file <file name> </code><br>
+<p dir="auto"><code class="notranslate">-d, --dataset file <file name> </code><br>
dataset description (in YAML format)</p>
-<p dir="auto"><code>-k, --kmer <int> </code><br>
+<p dir="auto"><code class="notranslate">-k, --kmer <int> </code><br>
k-mer length (default: 21)</p>
-<p dir="auto"><code>-t, --threads <int> </code><br>
+<p dir="auto"><code class="notranslate">-t, --threads <int> </code><br>
number of threads to use (default: number of CPUs)</p>
-<p dir="auto"><code>-o, --outdir <dir> </code><br>
+<p dir="auto"><code class="notranslate">-o, --outdir <dir> </code><br>
output directory to use (default: current directory)</p>
-<p dir="auto"><code>-c, --cov <value> </code><br>
+<p dir="auto"><code class="notranslate">-c, --cov <value> </code><br>
median kmer count threshold (read pairs, s.t. kmer count median for BOTH reads LESS OR EQUAL to this value will be ignored)</p>
-<p dir="auto"><code>-h, --help </code><br>
+<p dir="auto"><code class="notranslate">-h, --help </code><br>
print help message</p>
<p dir="auto"><a name="sec4.3"></a></p>
<h2 dir="auto">k-mer cardinality estimating</h2>
-<p dir="auto"><code>spades-kmer-estimating </code> is a tool for estimating approximate number of unique k-mers in the provided reads. Kmers from reverse-complementary reads aren"t taken into account for k-mer cardinality estimating.</p>
-<p dir="auto">To provide input data to SPAdes k-mer cardinality estimating tool <code>spades-kmer-estimating </code> you should provide dataset description file in YAML format.</p>
-<p dir="auto">Synopsis: <code>spades-kmer-estimating [OPTION...] -d <yaml></code></p>
+<p dir="auto"><code class="notranslate">spades-kmer-estimating </code> is a tool for estimating approximate number of unique k-mers in the provided reads. Kmers from reverse-complementary reads aren"t taken into account for k-mer cardinality estimating.</p>
+<p dir="auto">To provide input data to SPAdes k-mer cardinality estimating tool <code class="notranslate">spades-kmer-estimating </code> you should provide dataset description file in YAML format.</p>
+<p dir="auto">Synopsis: <code class="notranslate">spades-kmer-estimating [OPTION...] -d <yaml></code></p>
<p dir="auto">The options are:</p>
-<p dir="auto"><code>-d, --dataset file <file name> </code><br>
+<p dir="auto"><code class="notranslate">-d, --dataset file <file name> </code><br>
dataset description (in YAML format)</p>
-<p dir="auto"><code>-k, --kmer <int> </code><br>
+<p dir="auto"><code class="notranslate">-k, --kmer <int> </code><br>
k-mer length (default: 21)</p>
-<p dir="auto"><code>-t, --threads <int> </code><br>
+<p dir="auto"><code class="notranslate">-t, --threads <int> </code><br>
number of threads to use (default: number of CPUs)</p>
-<p dir="auto"><code>-h, --help </code><br>
+<p dir="auto"><code class="notranslate">-h, --help </code><br>
print help message</p>
<p dir="auto"><a name="sec4.4"></a></p>
<h2 dir="auto">Graph construction</h2>
-<p dir="auto">Graph construction tool <code>spades-gbuilder </code> has two mandatory options: dataset description file in YAML format and an output file name.</p>
-<p dir="auto">Synopsis: <code>spades-gbuilder <dataset description (in YAML)> <output filename> [-k <value>] [-t <value>] [-tmpdir <dir>] [-b <value>] [-unitigs|-fastg|-gfa|-spades]</code></p>
+<p dir="auto">Graph construction tool <code class="notranslate">spades-gbuilder </code> has two mandatory options: dataset description file in YAML format and an output file name.</p>
+<p dir="auto">Synopsis: <code class="notranslate">spades-gbuilder <dataset description (in YAML)> <output filename> [-k <value>] [-t <value>] [-tmpdir <dir>] [-b <value>] [-unitigs|-fastg|-gfa|-spades]</code></p>
<p dir="auto">Additional options are:</p>
-<p dir="auto"><code>-k <int> </code><br>
+<p dir="auto"><code class="notranslate">-k <int> </code><br>
k-mer length used for construction (must be odd)</p>
-<p dir="auto"><code>-t <int> </code><br>
+<p dir="auto"><code class="notranslate">-t <int> </code><br>
number of threads</p>
-<p dir="auto"><code>-tmp-dir <dir_name> </code><br>
+<p dir="auto"><code class="notranslate">-tmp-dir <dir_name> </code><br>
scratch directory to use</p>
-<p dir="auto"><code>-b <int> </code><br>
+<p dir="auto"><code class="notranslate">-b <int> </code><br>
sorting buffer size (per thread, in bytes)</p>
-<p dir="auto"><code>-unitigs </code><br>
+<p dir="auto"><code class="notranslate">-unitigs </code><br>
k-mer length used for construction (must be odd)</p>
-<p dir="auto"><code>-fastg </code><br>
+<p dir="auto"><code class="notranslate">-fastg </code><br>
output graph in FASTG format</p>
-<p dir="auto"><code>-gfa </code><br>
+<p dir="auto"><code class="notranslate">-gfa </code><br>
output graph in GFA1 format</p>
-<p dir="auto"><code>-spades </code><br>
+<p dir="auto"><code class="notranslate">-spades </code><br>
output graph in SPAdes internal format</p>
<p dir="auto"><a name="sec4.5"></a></p>
<h2 dir="auto">Long read to graph alignment</h2>
<p dir="auto"><a name="sec4.5.1"></a></p>
<h3 dir="auto">hybridSPAdes aligner</h3>
-<p dir="auto">A tool <code>spades-gmapper </code> gives opportunity to extract long read alignments generated with hybridSPAdes pipeline options. It has three mandatory options: dataset description file in YAML format, graph file in GFA format and an output file name.</p>
-<p dir="auto">Synopsis: <code>spades-gmapper <dataset description (in YAML)> <graph (in GFA)> <output filename> [-k <value>] [-t <value>] [-tmpdir <dir>]</code></p>
+<p dir="auto">A tool <code class="notranslate">spades-gmapper </code> gives opportunity to extract long read alignments generated with hybridSPAdes pipeline options. It has three mandatory options: dataset description file in YAML format, graph file in GFA format and an output file name.</p>
+<p dir="auto">Synopsis: <code class="notranslate">spades-gmapper <dataset description (in YAML)> <graph (in GFA)> <output filename> [-k <value>] [-t <value>] [-tmpdir <dir>]</code></p>
<p dir="auto">Additional options are:</p>
-<p dir="auto"><code>-k <int> </code><br>
+<p dir="auto"><code class="notranslate">-k <int> </code><br>
k-mer length that was used for graph construction</p>
-<p dir="auto"><code>-t <int> </code><br>
+<p dir="auto"><code class="notranslate">-t <int> </code><br>
number of threads</p>
-<p dir="auto"><code>-tmpdir <dir_name> </code><br>
+<p dir="auto"><code class="notranslate">-tmpdir <dir_name> </code><br>
scratch directory to use</p>
-<p dir="auto">While <code>spades-mapper</code> is a solution for those who work on hybridSPAdes assembly and want to get exactly its intermediate results, <a href="#sec4.5.2">SPAligner</a> is an end-product application for sequence-to-graph alignment with tunable parameters and output types.</p>
+<p dir="auto">While <code class="notranslate">spades-mapper</code> is a solution for those who work on hybridSPAdes assembly and want to get exactly its intermediate results, <a href="#sec4.5.2">SPAligner</a> is an end-product application for sequence-to-graph alignment with tunable parameters and output types.</p>
<p dir="auto"><a name="sec4.5.2"></a></p>
<h3 dir="auto">SPAligner</h3>
<p dir="auto">A tool for fast and accurate alignment of nucleotide sequences to assembly graphs. It takes file with sequences (in fasta/fastq format) and assembly in GFA format and outputs long read to graph alignment in various formats (such as tsv, fasta and <a href="https://github.com/ocxtal/gpa" title="GPA-format spec">GPA</a>).</p>
-<p dir="auto">Synopsis: <code>spaligner assembly/src/projects/spaligner_config.yaml -d <value> -s <value> -g <value> -k <value> [-t <value>] [-o <value>]</code></p>
+<p dir="auto">Synopsis: <code class="notranslate">spaligner assembly/src/projects/spaligner_config.yaml -d <value> -s <value> -g <value> -k <value> [-t <value>] [-o <value>]</code></p>
<p dir="auto">Parameters are:</p>
-<p dir="auto"><code>-d <type> </code><br>
+<p dir="auto"><code class="notranslate">-d <type> </code><br>
long reads type: nanopore, pacbio</p>
-<p dir="auto"><code>-s <filename> </code><br>
+<p dir="auto"><code class="notranslate">-s <filename> </code><br>
file with sequences (in fasta/fastq)</p>
-<p dir="auto"><code>-g <filename> </code><br>
+<p dir="auto"><code class="notranslate">-g <filename> </code><br>
file with graph (in GFA)</p>
-<p dir="auto"><code>-k <int> </code><br>
+<p dir="auto"><code class="notranslate">-k <int> </code><br>
k-mer length that was used for graph construction</p>
-<p dir="auto"><code>-t <int> </code><br>
+<p dir="auto"><code class="notranslate">-t <int> </code><br>
number of threads (default: 8)</p>
-<p dir="auto"><code>-o, --outdir <dir> </code><br>
+<p dir="auto"><code class="notranslate">-o, --outdir <dir> </code><br>
output directory to use (default: spaligner_result/)</p>
<p dir="auto">For more information on parameters and options please refer to main SPAligner manual (assembler/src/projects/spaligner/README.md).</p>
<p dir="auto">Also if you want to align protein sequences please refer to our <a href="https://github.com/ablab/spades/releases/tag/spaligner-paper">pre-release version</a>.</p>
@@ -880,5 +880,5 @@ output directory to use (default: spaligner_result/)</p>
<p dir="auto">In addition, we would like to list your publications that use our software on our website. Please email the reference, the name of your lab, department and institution to <a href="mailto:spades.support at cab.spbu.ru">spades.support at cab.spbu.ru</a></p>
<p dir="auto"><a name="sec6"></a></p>
<h1 dir="auto">Feedback and bug reports</h1>
-<p dir="auto">Your comments, bug reports, and suggestions are very welcomed. They will help us to further improve SPAdes. If you have any troubles running SPAdes, please send us <code>params.txt</code> and <code>spades.log</code> from the directory <code><output_dir></code>.</p>
+<p dir="auto">Your comments, bug reports, and suggestions are very welcomed. They will help us to further improve SPAdes. If you have any troubles running SPAdes, please send us <code class="notranslate">params.txt</code> and <code class="notranslate">spades.log</code> from the directory <code class="notranslate"><output_dir></code>.</p>
<p dir="auto">You can leave your comments and bug reports at <a href="https://github.com/ablab/spades/issues">our GitHub repository tracker</a> or sent it via e-mail: <a href="mailto:spades.support at cab.spbu.ru">spades.support at cab.spbu.ru</a></p><br/><br/><br/><br/><br/> </body> </html>
=====================================
assembler/src/cmake/pack.cmake
=====================================
@@ -12,10 +12,10 @@ set(CPACK_PACKAGE_NAME "SPAdes")
set(CPACK_PACKAGE_VENDOR "Saint Petersburg State University")
#set(CPACK_PACKAGE_DESCRIPTION_FILE "${SPADES_MAIN_SRC_DIR}/../README")
set(CPACK_RESOURCE_FILE_LICENSE "${SPADES_MAIN_SRC_DIR}/../LICENSE")
-set(CPACK_PACKAGE_VERSION "3.15.4")
+set(CPACK_PACKAGE_VERSION "3.15.5")
set(CPACK_PACKAGE_VERSION_MAJOR "3")
set(CPACK_PACKAGE_VERSION_MINOR "15")
-set(CPACK_PACKAGE_VERSION_PATCH "4")
+set(CPACK_PACKAGE_VERSION_PATCH "5")
set(CPACK_STRIP_FILES bin/spades-bwa bin/spades-core bin/spades-corrector-core bin/spades-gbuilder bin/spades-gmapper bin/spades-hammer bin/spades-ionhammer bin/spades-kmercount bin/spades-truseq-scfcorrection)
=====================================
assembler/src/common/assembly_graph/handlers/used_edge_handler.hpp
=====================================
@@ -0,0 +1,79 @@
+//***************************************************************************
+//* Copyright (c) 2022 Saint-Petersburg State University
+//* All Rights Reserved
+//* See file LICENSE for details.
+//****************************************************************************
+#pragma once
+#include "assembly_graph/core/action_handlers.hpp"
+#include <unordered_map>
+
+using namespace omnigraph;
+
+namespace omnigraph {
+
+ template<class Graph>
+ class UsedEdgeHandler : omnigraph::GraphActionHandler<Graph> {
+ typedef typename Graph::EdgeId EdgeId;
+
+ std::unordered_map<EdgeId, size_t> storage_;
+ size_t banned_bases_ = 0;
+
+ public:
+ UsedEdgeHandler(const Graph &g) :
+ omnigraph::GraphActionHandler<Graph>(g, "UsedEdgeHandler"), storage_() { }
+
+ void HandleAdd(EdgeId e) override {
+ storage_.emplace(e, 0);
+ }
+
+ void HandleDelete(EdgeId e) override {
+ storage_.erase(e);
+ }
+
+ void HandleMerge(const std::vector<EdgeId> &old_edges, EdgeId new_edge) override {
+ DEBUG("merging ");
+ size_t sum = 0;
+ for (EdgeId e : old_edges) {
+ DEBUG(e.int_id());
+ auto it = storage_.find(e);
+ if (it != storage_.end())
+ sum += it->second;
+ }
+ DEBUG("into " << new_edge.int_id());
+ storage_[new_edge] = sum;
+ }
+
+ void HandleGlue(EdgeId /*new_edge*/, EdgeId /*edge1*/, EdgeId /*edge2*/) override {
+ VERIFY(false);
+ }
+
+ void HandleSplit(EdgeId /*old_edge*/, EdgeId /*new_edge_1*/,
+ EdgeId /*new_edge_2*/) override {
+ VERIFY(false);
+ }
+
+ void AddUsed(EdgeId e) {
+ size_t was_used = 0;
+ auto it = storage_.find(e);
+ if (it != storage_.end())
+ was_used = it->second;
+
+ size_t new_used = this->g().length(e);
+ VERIFY(new_used >= was_used);
+ storage_[e] = new_used;
+ banned_bases_ += (new_used - was_used);
+ }
+
+ size_t GetUsedLength(EdgeId e) const {
+ auto it = storage_.find(e);
+ return it != storage_.end() ? it->second : 0;
+ }
+
+ size_t size() const {
+ return banned_bases_;
+ }
+ };
+
+}
+
+
=====================================
assembler/src/common/modules/alignment/pacbio/gap_filler.hpp
=====================================
@@ -120,7 +120,7 @@ class GapFiller {
MappingPoint p, PathRange &range, bool forward, GraphPosition &old_start_pos) const;
const debruijn_graph::Graph &g_;
- const GAlignerConfig &cfg_;
+ const GAlignerConfig cfg_;
};
=====================================
assembler/src/projects/spades/contig_output_stage.cpp
=====================================
@@ -10,6 +10,7 @@
#include "assembly_graph/core/graph.hpp"
#include "assembly_graph/paths/bidirectional_path.hpp"
#include "assembly_graph/paths/bidirectional_path_io/bidirectional_path_output.hpp"
+#include "assembly_graph/handlers/used_edge_handler.hpp"
#include "modules/path_extend/pe_resolver.hpp"
#include "modules/path_extend/pe_utils.hpp"
#include "io/dataset_support/read_converter.hpp"
@@ -19,10 +20,11 @@
namespace {
using namespace debruijn_graph;
+using UsedEdges = omnigraph::UsedEdgeHandler<Graph>;
static constexpr double LARGE_FRACTION = 0.8;
-bool CheckUsedPath(const path_extend::BidirectionalPath &path, std::unordered_set<EdgeId> &used_edges) {
+bool CheckUsedPath(const path_extend::BidirectionalPath &path, UsedEdges &used_edges) {
const Graph& g = path.g();
size_t used_len = 0;
size_t total_len = 0;
@@ -30,22 +32,20 @@ bool CheckUsedPath(const path_extend::BidirectionalPath &path, std::unordered_se
for (size_t i = 0; i < path_len; i++) {
size_t cur_len = g.length(path.At(i));
total_len += cur_len;
- if (used_edges.count(path.At(i))) {
- used_len += cur_len;
- }
+ used_len += used_edges.GetUsedLength(path.At(i));
}
for (size_t i = 0; i < path_len; i++) {
- used_edges.insert(path.At(i));
- used_edges.insert(g.conjugate(path.At(i)));
+ used_edges.AddUsed(path.At(i));
+ used_edges.AddUsed(g.conjugate(path.At(i)));
}
//FIXME: constant
return (math::ge((double)used_len, (double)total_len * LARGE_FRACTION));
}
-path_extend::PathContainer GetCircularScaffolds(const path_extend::PathContainer &sc_storage, std::unordered_set<EdgeId> &used_edges, size_t min_circular_length) {
+path_extend::PathContainer GetCircularScaffolds(const path_extend::PathContainer &sc_storage, UsedEdges &used_edges, size_t min_circular_length) {
path_extend::PathContainer res;
- INFO("Banned " << used_edges.size() <<" used edges");
+ INFO("Banned " << used_edges.size() <<" used bases");
for (const auto &entry : sc_storage) {
const path_extend::BidirectionalPath &path = *entry.first;
@@ -61,7 +61,7 @@ path_extend::PathContainer GetCircularScaffolds(const path_extend::PathContainer
return res;
}
-path_extend::PathContainer GetTipScaffolds(const path_extend::PathContainer &sc_storage, const std::unordered_set<VertexId> &forbidden_vertices, std::unordered_set<EdgeId> &used_edges, size_t min_linear_length) {
+path_extend::PathContainer GetTipScaffolds(const path_extend::PathContainer &sc_storage, const std::unordered_set<VertexId> &forbidden_vertices, UsedEdges &used_edges, size_t min_linear_length) {
path_extend::PathContainer res;
for (const auto &entry : sc_storage) {
const path_extend::BidirectionalPath &path = *entry.first;
@@ -211,7 +211,6 @@ void ContigOutput::run(GraphPack &gp, const char*) {
fastg_writer));
if (outputs_.count(Kind::PlasmidContigs)) {
- using UsedEdges = omnigraph::SmartContainer<std::unordered_set<EdgeId>, Graph>;
if (!gp.count<UsedEdges>("used_edges"))
gp.add("used_edges", UsedEdges(graph));
PathContainer circulars = GetCircularScaffolds(broken_scaffolds, gp.get_mutable<UsedEdges>("used_edges"), cfg::get().pd->min_circular_length);
=====================================
assembler/src/projects/spades/domain_matcher.cpp
=====================================
@@ -32,14 +32,20 @@ extern "C" {
namespace nrps {
-static void match_contigs_internal(hmmer::HMMMatcher &matcher, const path_extend::BidirectionalPath &path,
- const std::string &path_string,
- const std::string &type, const std::string &desc,
- ContigAlnInfo &res, io::OFastaReadStream &oss_contig, size_t model_length) {
- for (size_t shift = 0; shift < 3; ++shift) {
- std::string ref_shift = std::to_string(path.GetId()) + "_" + std::to_string(shift);
- std::string seq_aas = aa::translate(path_string.c_str() + shift);
- matcher.match(ref_shift.c_str(), seq_aas.c_str());
+static void MatchContigsInternal(hmmer::HMMMatcher &matcher, const path_extend::BidirectionalPath &path,
+ const std::string &path_string,
+ const std::string &type, const std::string &desc,
+ ContigAlnInfo &res, io::OFastaReadStream &oss_contig, size_t model_length,
+ bool isAA = true) {
+ if (isAA) {
+ for (size_t shift = 0; shift < 3; ++shift) {
+ std::string ref_shift = std::to_string(path.GetId()) + "_" + std::to_string(shift);
+ std::string seq_aas = aa::translate(path_string.c_str() + shift);
+ matcher.match(ref_shift.c_str(), seq_aas.c_str());
+ }
+ } else {
+ std::string ref_shift = std::to_string(path.GetId()) + "_0";
+ matcher.match(ref_shift.c_str(), path_string.c_str());
}
matcher.summarize();
@@ -57,8 +63,8 @@ static void match_contigs_internal(hmmer::HMMMatcher &matcher, const path_extend
continue;
}
int shift = hit.name()[strlen(hit.name()) - 1] - '0';
- seqpos.first = seqpos.first * 3 + shift;
- seqpos.second = seqpos.second * 3 + shift;
+ seqpos.first = seqpos.first * (isAA ? 3 : 1) + shift;
+ seqpos.second = seqpos.second * (isAA ? 3 : 1) + shift;
std::string name(hit.name());
#pragma omp critical
@@ -75,30 +81,31 @@ static void match_contigs_internal(hmmer::HMMMatcher &matcher, const path_extend
matcher.reset_top_hits();
}
-static void match_contigs(const path_extend::PathContainer &contig_paths, const path_extend::ScaffoldSequenceMaker &scaffold_maker,
- const hmmer::HMM &hmm, const hmmer::hmmer_cfg &cfg,
- ContigAlnInfo &res, io::OFastaReadStream &oss_contig) {
+static void MatchContigs(const path_extend::PathContainer &contig_paths, const path_extend::ScaffoldSequenceMaker &scaffold_maker,
+ const hmmer::HMM &hmm, const hmmer::hmmer_cfg &cfg,
+ ContigAlnInfo &res, io::OFastaReadStream &oss_contig) {
DEBUG("Total contigs: " << contig_paths.size());
DEBUG("Model length - " << hmm.length());
hmmer::HMMMatcher matcher(hmm, cfg);
+ bool isAA = hmm.abc()->type == eslAMINO;
for (auto iter = contig_paths.begin(); iter != contig_paths.end(); ++iter) {
const path_extend::BidirectionalPath &path = iter.get();
if (path.Length() <= 0)
continue;
std::string path_string = scaffold_maker.MakeSequence(path);
- match_contigs_internal(matcher, path, path_string,
- hmm.name(), hmm.desc() ? hmm.desc() : "",
- res, oss_contig, hmm.length());
+ MatchContigsInternal(matcher, path, path_string,
+ hmm.name(), hmm.desc() ? hmm.desc() : "",
+ res, oss_contig, hmm.length(), isAA);
const path_extend::BidirectionalPath& conj_path = iter.getConjugate();
if (conj_path.Length() <= 0)
continue;
std::string path_string_conj = scaffold_maker.MakeSequence(conj_path);
- match_contigs_internal(matcher, conj_path, path_string_conj,
- hmm.name(), hmm.desc() ? hmm.desc() : "",
- res, oss_contig, hmm.length());
+ MatchContigsInternal(matcher, conj_path, path_string_conj,
+ hmm.name(), hmm.desc() ? hmm.desc() : "",
+ res, oss_contig, hmm.length(), isAA);
}
}
@@ -116,10 +123,12 @@ static void ParseHMMFile(std::vector<hmmer::HMM> &hmms, const std::string &filen
}
}
-static void ParseFASTAFile(std::vector<hmmer::HMM> &hmms, const std::string &filename) {
- hmmer::HMMSequenceBuilder builder(hmmer::Alphabet::AMINO, hmmer::ScoreSystem::Default);
+static void ParseFASTAFile(std::vector<hmmer::HMM> &hmms,
+ const std::string &filename, bool useAA = true) {
+ hmmer::HMMSequenceBuilder builder(useAA ? hmmer::Alphabet::AMINO : hmmer::Alphabet::DNA,
+ hmmer::ScoreSystem::Default);
- ESL_ALPHABET *abc = esl_alphabet_Create(eslAMINO);
+ ESL_ALPHABET *abc = esl_alphabet_Create(useAA ? eslAMINO : eslDNA);
ESL_SQ *qsq = esl_sq_CreateDigital(abc);
ESL_SQFILE *qfp = NULL;
const char *qfile = filename.c_str();
@@ -138,7 +147,7 @@ static void ParseFASTAFile(std::vector<hmmer::HMM> &hmms, const std::string &fil
// For each sequence, build a model and save it.
while ((status = esl_sqio_Read(qfp, qsq)) == eslOK) {
- INFO("Converting " << qsq->name << ", len: " << qsq->n);
+ INFO("Converting " << (useAA ? "AA" : "DNA") << " sequence " << qsq->name << ", len: " << qsq->n);
hmms.push_back(builder.from_string(qsq));
esl_sq_Reuse(qsq);
}
@@ -174,14 +183,19 @@ ContigAlnInfo DomainMatcher::MatchDomains(debruijn_graph::GraphPack &gp,
std::vector<hmmer::HMM> hmms;
for (const auto &f : hmm_files) {
if (utils::ends_with(f, ".aa") || utils::ends_with(f, ".aa.gz")) {
- ParseFASTAFile(hmms, f);
+ ParseFASTAFile(hmms, f, true);
+ hcfg.E = hcfg.domE = 0.01;
+ } else if (utils::ends_with(f, ".fa") || utils::ends_with(f, ".fa.gz") |
+ utils::ends_with(f, ".fna") || utils::ends_with(f, ".fna.gz")) {
+ ParseFASTAFile(hmms, f, false);
hcfg.E = hcfg.domE = 0.01;
} else {
ParseHMMFile(hmms, f);
}
}
- // Setup E-value search space size
+ // Setup E-value search space size. We always use larger size (AA-based),
+ // so it will be a bit conservative for nucleotide HMMs / sequences
hcfg.Z = 3 * broken_scaffolds.size();
# pragma omp parallel for
@@ -193,9 +207,9 @@ ContigAlnInfo DomainMatcher::MatchDomains(debruijn_graph::GraphPack &gp,
INFO("Matching contigs with " << name);
}
- match_contigs(broken_scaffolds, scaffold_maker,
- hmms[i], hcfg,
- local_res, oss_contig);
+ MatchContigs(broken_scaffolds, scaffold_maker,
+ hmms[i], hcfg,
+ local_res, oss_contig);
# pragma omp critical
{
=====================================
assembler/src/spades_pipeline/options_parser.py
=====================================
@@ -940,7 +940,9 @@ def add_to_cfg(cfg, log, bin_home, spades_home, args):
hmms = ""
is_hmmfile= lambda hmmfile: os.path.isfile(hmmfile) \
and (hmmfile.endswith("hmm") or hmmfile.endswith("hmm.gz") or \
- hmmfile.endswith("aa") or hmmfile.endswith("aa.gz"))
+ hmmfile.endswith("aa") or hmmfile.endswith("aa.gz") or \
+ hmmfile.endswith("fa") or hmmfile.endswith("fa.gz") or \
+ hmmfile.endswith("fna") or hmmfile.endswith("fna.gz"))
if os.path.isdir(hmms_path):
hmms = ",".join([os.path.join(hmms_path, hmmfile)
for hmmfile in os.listdir(hmms_path)
@@ -1044,10 +1046,19 @@ def postprocessing(args, cfg, dataset_data, log, spades_home, load_processed_dat
if args.careful:
support.error("you cannot specify --careful in RNA-Seq mode!", log)
- modes_count = [args.meta, args.large_genome, args.truseq_mode, args.rna, args.plasmid, args.single_cell, args.isolate, args.rnaviral].count(True)
- if modes_count > 1 and ([args.meta, args.plasmid].count(True) < 2 and [args.meta, args.bio].count(True) < 2 and [args.meta, args.rnaviral].count(True) < 2):
- support.error("you cannot simultaneously use more than one mode out of "
- "Isolate, Metagenomic, Large genome, Illumina TruSeq, RNA-Seq, Plasmid, and Single-cell (except combining Metagenomic and Plasmid)!", log)
+ modes_count = [args.large_genome, args.rna, args.plasmid, args.meta, args.single_cell, args.isolate, args.rnaviral,
+ args.corona, args.metaviral, args.metaplasmid, args.bio].count(True)
+ is_metaplasmid = modes_count == 3 and [args.meta, args.plasmid, args.metaplasmid].count(True) == 3
+ is_bgc = modes_count == 2 and [args.meta, args.bio].count(True) == 2
+ is_metaviral = modes_count == 3 and [args.meta, args.plasmid, args.metaviral].count(True) == 3
+ is_rnaviral = modes_count == 2 and [args.meta, args.rnaviral].count(True) == 2
+ is_corona = modes_count == 3 and [args.meta, args.rnaviral, args.corona].count(True) == 3
+ if not (modes_count <= 1 or is_metaplasmid or is_bgc or is_metaviral or is_rnaviral or is_corona):
+ # correct cases:
+ # - either there is 1 or 0 modes specified
+ # - or there is 1 of 5 allowed combinations
+ # everything else is forbidden
+ support.error("Specified mode combination is not supported! Check out user manual for available modes.", log)
elif modes_count == 0:
support.warning("No assembly mode was specified! If you intend to assemble high-coverage multi-cell/isolate data, use '--isolate' option.")
=====================================
assembler/src/spades_pipeline/stages/correction_stage.py
=====================================
@@ -10,7 +10,6 @@
import os
import shutil
import sys
-from distutils import dir_util
from site import addsitedir
from stages import stage
@@ -71,7 +70,7 @@ class CorrectionIterationStage(stage.Stage):
dst_configs = os.path.join(self.cfg.output_dir, "configs")
if os.path.isdir(dst_configs):
shutil.rmtree(dst_configs)
- dir_util.copy_tree(os.path.join(self.tmp_configs_dir, "corrector"), dst_configs, preserve_times=False)
+ support.copy_tree(os.path.join(self.tmp_configs_dir, "corrector"), dst_configs, preserve_times=False)
cfg_file_name = os.path.join(dst_configs, "corrector.info")
self.cfg.tmp_dir = support.get_tmp_dir(prefix="corrector_")
=====================================
assembler/src/spades_pipeline/stages/error_correction_stage.py
=====================================
@@ -10,7 +10,6 @@
import os
import shutil
import sys
-from distutils import dir_util
from site import addsitedir
import commands_parser
@@ -63,10 +62,10 @@ class ECRunningToolStage(stage.Stage):
if os.path.isdir(dst_configs):
shutil.rmtree(dst_configs)
if cfg.iontorrent:
- dir_util.copy_tree(os.path.join(self.tmp_configs_dir, "ionhammer"), dst_configs, preserve_times=False)
+ support.copy_tree(os.path.join(self.tmp_configs_dir, "ionhammer"), dst_configs, preserve_times=False)
cfg_file_name = os.path.join(dst_configs, "ionhammer.cfg")
else:
- dir_util.copy_tree(os.path.join(self.tmp_configs_dir, "hammer"), dst_configs, preserve_times=False)
+ support.copy_tree(os.path.join(self.tmp_configs_dir, "hammer"), dst_configs, preserve_times=False)
cfg_file_name = os.path.join(dst_configs, "config.info")
cfg.tmp_dir = support.get_tmp_dir(prefix="hammer_")
=====================================
assembler/src/spades_pipeline/stages/pipeline.py
=====================================
@@ -9,8 +9,8 @@
import os
import shutil
-from distutils import dir_util
+import support
import options_storage
class Pipeline(object):
@@ -22,10 +22,10 @@ class Pipeline(object):
shutil.rmtree(tmp_configs_dir)
if not os.path.isdir(tmp_configs_dir):
if options_storage.args.configs_dir:
- dir_util.copy_tree(options_storage.args.configs_dir, tmp_configs_dir, preserve_times=False,
+ support.copy_tree(options_storage.args.configs_dir, tmp_configs_dir, preserve_times=False,
preserve_mode=False)
else:
- dir_util.copy_tree(os.path.join(spades_home, "configs"), tmp_configs_dir, preserve_times=False,
+ support.copy_tree(os.path.join(spades_home, "configs"), tmp_configs_dir, preserve_times=False,
preserve_mode=False)
def add(self, stage):
=====================================
assembler/src/spades_pipeline/stages/scaffold_correction_stage.py deleted
=====================================
@@ -1,112 +0,0 @@
-#!/usr/bin/env python
-
-############################################################################
-# Copyright (c) 2015-2019 Saint Petersburg State University
-# Copyright (c) 2011-2014 Saint Petersburg Academic University
-# All Rights Reserved
-# See file LICENSE for details.
-############################################################################
-
-import os
-import shutil
-from distutils import dir_util
-
-import commands_parser
-import options_storage
-from stages import stage
-import process_cfg
-from process_cfg import bool_to_str
-
-# TODO copypast from iteraton stage
-READS_TYPES_USED_IN_CONSTRUCTION = ["paired-end", "single", "hq-mate-pairs"]
-READS_TYPES_USED_IN_RNA_SEQ = ["paired-end", "single", "trusted-contigs", "untrusted-contigs"]
-
-
-def prepare_config_scaffold_correction(filename, cfg, log, saves_dir, K):
- subst_dict = dict()
-
- subst_dict["K"] = str(K)
- subst_dict["dataset"] = process_cfg.process_spaces(cfg.dataset)
- subst_dict["output_base"] = process_cfg.process_spaces(os.path.join(cfg.output_dir, "SCC"))
- subst_dict["tmp_dir"] = process_cfg.process_spaces(cfg.tmp_dir)
- subst_dict["use_additional_contigs"] = bool_to_str(False)
- subst_dict["main_iteration"] = bool_to_str(False)
- subst_dict["entry_point"] = options_storage.BASE_STAGE
- subst_dict["load_from"] = saves_dir
- subst_dict["developer_mode"] = bool_to_str(cfg.developer_mode)
- subst_dict["max_threads"] = cfg.max_threads
- subst_dict["max_memory"] = cfg.max_memory
-
- # todo
- process_cfg.substitute_params(filename, subst_dict, log)
-
-
-def add_configs(command, configs_dir):
- # Order matters here!
- mode_config_mapping = [("single_cell", "mda_mode"),
- ("meta", "meta_mode"),
- ("truseq_mode", "moleculo_mode"),
- ("rna", "rna_mode"),
- ("large_genome", "large_genome_mode"),
- ("plasmid", "plasmid_mode")]
- # ("careful", "careful_mode"),
- for (mode, config) in mode_config_mapping:
- if options_storage.args.__dict__[mode]:
- if mode == "rna" or mode == "meta":
- command.append(os.path.join(configs_dir, "mda_mode.info"))
- command.append(os.path.join(configs_dir, config + ".info"))
- if options_storage.args.__dict__["careful"]:
- if options_storage.args.__dict__["single_cell"]:
- command.append(os.path.join(configs_dir, "careful_mda_mode.info"))
- else:
- command.append(os.path.join(configs_dir, "careful_mode.info"))
-
- # special case: extra config
- if options_storage.args.rna and options_storage.args.fast:
- command.append(os.path.join(configs_dir, "rna_fast_mode.info"))
-
-
-class ScaffoldCorrectionStage(stage.Stage):
- def __init__(self, latest, *args):
- super(ScaffoldCorrectionStage, self).__init__(*args)
- self.latest = latest
-
- def generate_config(self, cfg):
- K = cfg.iterative_K[-1]
- latest = os.path.join(cfg.output_dir, "K%d" % K)
- K = options_storage.SCC_K
- data_dir = os.path.join(cfg.output_dir, "SCC", "K%d" % K)
- saves_dir = os.path.join(data_dir, "saves")
- dst_configs = os.path.join(data_dir, "configs")
- cfg_file_name = os.path.join(dst_configs, "config.info")
-
- if os.path.isdir(data_dir):
- shutil.rmtree(data_dir)
- os.makedirs(data_dir)
-
- dir_util.copy_tree(os.path.join(self.tmp_configs_dir, "debruijn"), dst_configs, preserve_times=False)
-
- scaffolds_file = os.path.join(latest, "scaffolds.fasta")
- if "read_buffer_size" in cfg.__dict__:
- construction_cfg_file_name = os.path.join(dst_configs, "construction.info")
- process_cfg.substitute_params(construction_cfg_file_name, {"read_buffer_size": cfg.read_buffer_size},
- self.log)
- process_cfg.substitute_params(os.path.join(dst_configs, "moleculo_mode.info"),
- {"scaffolds_file": scaffolds_file}, self.log)
- prepare_config_scaffold_correction(cfg_file_name, cfg, self.log, saves_dir, K)
-
- def get_command(self, cfg):
- K = options_storage.SCC_K
- data_dir = os.path.join(cfg.output_dir, "SCC", "K%d" % K)
- dst_configs = os.path.join(data_dir, "configs")
- cfg_file_name = os.path.join(dst_configs, "config.info")
-
- args = [cfg_file_name]
- add_configs(args, dst_configs)
- command = [commands_parser.Command(
- STAGE="SCC",
- path=os.path.join(self.bin_home, "spades-truseq-scfcorrection"),
- args=args,
- config_dir=os.path.relpath(data_dir, options_storage.args.output_dir),
- short_name=self.short_name)]
- return command
=====================================
assembler/src/spades_pipeline/stages/spades_iteration_stage.py
=====================================
@@ -9,11 +9,11 @@
import os
import shutil
-from distutils import dir_util
import commands_parser
import options_storage
from stages import stage
+import support
import process_cfg
from process_cfg import bool_to_str
@@ -139,9 +139,7 @@ class IterationStage(stage.Stage):
if self.get_stage(self.short_name) == options_storage.BASE_STAGE:
if not os.path.isdir(data_dir):
os.makedirs(data_dir)
-
- dir_util._path_created = {} # see http://stackoverflow.com/questions/9160227/dir-util-copy-tree-fails-after-shutil-rmtree
- dir_util.copy_tree(os.path.join(self.tmp_configs_dir, "debruijn"), dst_configs, preserve_times=False)
+ support.copy_tree(os.path.join(self.tmp_configs_dir, "debruijn"), dst_configs, preserve_times=False)
if self.prev_K:
additional_contigs_dname = os.path.join(cfg.output_dir, "K%d" % self.prev_K, "simplified_contigs")
=====================================
assembler/src/spades_pipeline/stages/spades_stage.py
=====================================
@@ -15,7 +15,6 @@ from site import addsitedir
import commands_parser
import options_storage
from stages import stage
-from stages import scaffold_correction_stage
from stages import spades_iteration_stage
import support
from process_cfg import merge_configs
@@ -325,16 +324,6 @@ class SpadesStage(stage.Stage):
if last_one:
break
- if self.cfg.correct_scaffolds:
- self.stages.append(scaffold_correction_stage.ScaffoldCorrectionStage(self.latest,
- "scc",
- self.output_files,
- self.tmp_configs_dir,
- self.dataset_data, self.log,
- self.bin_home,
- self.ext_python_modules_home,
- self.python_modules_home))
- self.latest = os.path.join(os.path.join(self.cfg.output_dir, "SCC"), "K21")
if options_storage.args.plasmid and options_storage.args.meta:
self.stages.append(PlasmidGlueFileStage(self.latest, "plasmid_copy_files",
self.output_files,
=====================================
assembler/src/spades_pipeline/support.py
=====================================
@@ -940,3 +940,30 @@ def is_int(value):
return True
except ValueError:
return False
+
+
+# shutil.copyfile does not copy any metadata (time and permission), so one
+# cannot expect preserve_mode = False and preserve_times = True to work.
+def copy_tree(src, dst, preserve_times=True, preserve_mode=True):
+ if sys.version.split()[0][0] == '2':
+ from distutils import dir_util
+ dir_util._path_created = {} # see http://stackoverflow.com/questions/9160227/dir-util-copy-tree-fails-after-shutil-rmtree
+ dir_util.copy_tree(src, dst, preserve_times=preserve_times, preserve_mode=preserve_mode)
+ return
+
+ if not preserve_mode:
+ copy_fn = shutil.copyfile
+ else:
+ copy_fn = shutil.copy2
+
+ if os.path.exists(dst):
+ shutil.rmtree(dst)
+
+ # shutil.copytree preserves the timestamp, so we must update it afterwards.
+ shutil.copytree(src, dst, copy_function = copy_fn)
+
+ if not preserve_times:
+ for dirpath, _, filenames in os.walk(dst):
+ os.utime(dirpath, None)
+ for file in filenames:
+ os.utime(os.path.join(dirpath, file), None)
View it on GitLab: https://salsa.debian.org/med-team/spades/-/commit/3d6cb8fc3954b52b33a05e4b3b0515a750628653
--
View it on GitLab: https://salsa.debian.org/med-team/spades/-/commit/3d6cb8fc3954b52b33a05e4b3b0515a750628653
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/debian-med-commit/attachments/20220724/74213d0e/attachment-0001.htm>
More information about the debian-med-commit
mailing list