/usr/share/spades/truspades_manual.html is in spades 3.11.1+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 | <html>
<head>
<title>truSPAdes 1.0 Manual</title>
<style type="text/css">
.code {
background-color: lightgray;
}
</style>
</head>
<body>
<h1>TruSPAdes 1.0 Manual</h1>
1. <a href="#sec1">About truSPAdes</a><br>
1.1. <a href="#sec1.1">Illumina TruSeq data</a><br>
1.2. <a href="#sec1.2">TruSPAdes input</a><br>
1.3. <a href="#sec1.3">TruSPAdes performance</a><br>
1.4. <a href="#sec1.4">Installation</a><br>
2. <a href="#sec2">TruSPAdes input format</a><br>
1.2.1. <a href="#sec2.1">Dataset file format</a><br>
1.2.2. <a href="#sec2.2">Read files naming for automatic dataset file generation</a><br>
3. <a href="#sec3">Running truSPAdes</a><br>
3.1. <a href="#sec3.1">TruSPAdes command line options</a><br>
3.2. <a href="#sec3.2">TruSPAdes output</a><br>
4. <a href="#sec4">Citation</a><br>
5. <a href="#sec5">Feedback and bug reports</a><br>
<br>
<a name="sec1"></a>
<h2>1. About truSPAdes</h2>
<p>
TruSPAdes is an assembler for short reads produced by Illumina TruSeq Long Read technology.
TruSPAdes accepts as an input a collection of demultiplexed TruSeq reads and assembles long virtual reads.
This manual will help you to use truSPAdes.</br>
<a name="sec1.1"></a>
<h3>1.1 Illumina TruSeq data</h3>
TruSeq Synthetic Long Reads technology is based on fragmenting genomic DNA into large segments (about 10Kb long) and forming random pools of the resulting segments (each pool contains about 300 segments).
Next, these fragments are clonally amplified, sheared, and marked with a unique barcode.
Afterwards, they are sequenced using the standard Illumina short reads technology.
All short reads originating from the same barcode are assembled together resulting in a set of long contigs (this step is called TruSeq barcode assembly).
Ideally, the result of such sequencing effort for a single barcode is the collection of 300 fragments (each fragment is about 10kb long) from a genome forming 300 long virtual reads.
Together, these segments are expected to cover about 3 million nucleotides (barcode span).
TruSPAdes is a tool for barcode assembly.
TruSPAdes assembles each barcode separately and outputs assembled contigs as Virtual TruSeq Long Reads (TSLRs).
<a name="sec1.2"></a>
<h3>1.2 TruSPAdes input</h3>
TruSPAdes requires demultiplexed sequencing data as an input.
Each barcode is assembled from one or several (in case multiple lanes are available) libraries of paired-end reads in fastq format.
Also note that truSPAdes can handle both compressed and decompressed reads.
TruSPAdes uses <a href="#sec1.2.1">dataset file format</a> for TruSeq dataset description.
Dataset file can be either created manually or generated automatically.
Since TruSeq reads are provided as a service by Illumina, most TruSeq read files have <a href="#sec1.2.2">particular naming patterns</a> that we use for autogeneration of dataset file.
See details in <a href="#sec2">section 2</a>.
<a name="sec1.3"></a>
<h3>1.3 TruSPAdes performance</h3>
TruSPAdes assembles standard Illumina TruSeq dataset (consisting of 384 barcodes) in 30 hours using 8 threads of Intel Xeon 2.27GHz processor and requires less than 16 Gb RAM (2Gb RAM per thread).
<a name="sec1.4"></a>
<h3>1.4 Installation</h3>
<p>
TruSPAdes comes as a part of SPAdes genome assembler. See <a href = manual.html#sec2>SPAdes manual</a> for installation instructions.
<a name="sec2"></a>
<h2>2. TruSPAdes input format</h2>
TruSPAdes uses <a href="#sec1.2.1">dataset file format</a> for TruSeq dataset description.
Dataset file can be either created manually or generated automatically.
Below we describe dataset file format and conditions that enable automatic generation of dataset files.
<a name="sec2.1"></a>
<h3>2.1 Dataset file format</h3>
Dataset file describes a collection of read files.
Each line in dataset file contains description of reads corresponding to a single barcode.
Description should start with id of barcode (a string consisting of letters and digits) followed by paths to reads.
For example, for dataset with three barcodes dataset file should look like this:
<pre class="code">
<code>
barcodeId1 /FULL_PATH_TO_LEFT_READS1/LEFT_READS_FILE_NAME1.fastq.gz /FULL_PATH_TO_RIGHT_READS1/RIGHT_READS_FILE_NAME1.fastq.gz
barcodeId2 /FULL_PATH_TO_LEFT_READS2/LEFT_READS_FILE_NAME2.fastq.gz /FULL_PATH_TO_RIGHT_READS2/RIGHT_READS_FILE_NAME2.fastq.gz
barcodeId3 /FULL_PATH_TO_LEFT_READS3/LEFT_READS_FILE_NAME3.fastq.gz /FULL_PATH_TO_RIGHT_READS3/RIGHT_READS_FILE_NAME3.fastq.gz
</code>
</pre>
In case several lanes are available for a barcode, reads for each lane should be provided in the same line.
Reads from the same barcode should be written consequently, e.g., in case two lanes are available for barcode, its description should look like this:
<pre class="code">
<code>
barcodeId /LEFT_READS_PATH_L1.fastq.gz /RIGHT_READS_PATH_L1.fastq.gz /LEFT_READS_PATH_L2.fastq.gz /RIGHT_READS_PATH_L2.fastq.gz
</code>
</pre>
Dataset file can be provided using <code>--dataset</code> option (see <a href="#sec3">section 3</a>).
<a name="sec2.2"></a>
<h3>2.2 Read files naming for automatic dataset file generation</h3>
Since TruSeq reads are provided as a service by Illumina, most TruSeq read files have particular naming patterns that we use to automatically generate dataset files.
If read naming in your dataset reads satisfies conditions described below you can avoid manual creation of dataset file and use <code>--input-dir</code> option instead (see <a href="#sec3">section 3</a>).
The conditions that enable automatic dataset file generation are as follows:
<ul>
<li>All reads should be in one or several directories provided using <code>--input-dir</code> option</li>
<li>No other files should be present in these directories</li>
<li>Names of files with left (right) reads should contain "R1" ("R2") as their substring.</li>
<li>Files with left and right reads of the same library should be in the same directory and their names should differ only by substitution of "R1" to "R2"</li>
<li>In case several lanes are available, reads from the same lane can be marked with "L<n>" label (i.e. contain it as a substring of read name) where <n> is the lane number. </li>
<li>Reads from the same barcode but from different lanes can be put into different directories but their names should either coinside or differ only by "L<n>" markings.</li>
<li>All barcodes should have the same number of paired-end libraries (lanes). This is to check for possibly missing or extra files in input directories.</li>
</ul>
For example dataset with two lanes and two barcodes can be put into single directory with the following file naming:
<pre class = "code">
<code>
dataset-directory:
reads_L1_R1.fastq
reads_L1_R2.fastq
reads_L2_R1.fastq
reads_L2_R2.fastq
</code>
</pre>
Or dataset files can be put into two directories:
<pre class = "code">
<code>
dataset_directory_L1:
reads_R1.fastq
reads_R2.fastq
dataset_directory_L2:
reads_R1.fastq
reads_R2.fastq
</code>
</pre>
<a name="sec3"></a>
<h2>3. Running truSPAdes</h2>
<a name="sec3.1"></a>
<h3>3.1 TruSPAdes command line options </h3>
<p>
To run truSPAdes from the command line, type
<pre class="code">
<code>
truspades.py [options] -o <output_dir>
</code>
</pre>
Note that we assume that truSPAdes installation directory is added to the <code>PATH</code> variable (provide full path to truSPAdes executable otherwise: <code><truspades installation dir>/truspades.py</code>).
<a name="basicopt"></a>
<h4>Basic options</h4>
<p>
<code>-o <output_dir> </code><br>
Specify the output directory. Required option.
</p>
<p>
<code>-h</code> (or <code>--help</code>)<br>
Prints help.
</p>
<p>
<code>-v</code> (or <code>--version</code>)<br>
Prints version.
</p>
<p>
<code>--continue</code><br>
Continues truSPAdes run from the specified output folder.
</p>
<p>
<code>-t <int></code> (or <code>--threads <int></code>)<br>
Number of threads. The default value is 8.
</p>
<a name="inputdata"></a>
<h4>Input data</h4>
<p>
<code>--dataset <file_name> </code><br>
Dataset file foratted as specified in <a href="#sec2.1">section 2.1</a>.
</p>
<p>
<code>--input-dir <dir_name> </code><br>
Directory containing reads. Note that naming of read files should satisfy conditions described in <a href="#sec2.2">section 2.2</a>.
</p>
<a name="sec3.2">
<h3>3.2. TruSPAdes output</h3>
<p>
TruSPAdes stores all output files in <code><output_dir> </code>, which is set by the user.
Resulting TruSeq long reads will be stored in <code><output_dir>/TSLRs.fastq</code>
The full list of <code><output_dir></code> content is presented below:
</p>
<pre>
<code>TSLRs.fastq</code> – <i>resulting truseq long reads</i>
<code>TSLRs.fasta</code> – <i>resulting truseq long reads in fasta format</i>
<code>dataset.info</code> – <i>dataset file</i>
<code>truspades.log</code> – <i>truSPAdes log file</i>
<code>barcodes</code> – <i>directory containing output files for separate barcodes</i>
<code>logs</code> – <i>directory containing log files for barcode assembly</i>
</pre>
<a name="sec4">
<h2>4. Citation</h2>
<p>
If you use truSPAdes in your research, please include <a href="http://www.nature.com/nmeth/journal/vaop/ncurrent/full/nmeth.3737.html" target="_blank">Bankevich & Pevzner, 2016</a> in your reference list.
<a name="sec5">
<h2>5. Feedback and bug reports</h2>
<p>
Your comments, bug reports, and suggestions are very welcomed. They will help us to further improve truSPAdes.
<p>
If you have any troubles running truSPAdes, please send us <code>dataset.info</code> and <code>truspades.log</code> from the directory <code><output_dir></code>.
<p>
Address for communications: <a href="mailto:spades.support@cab.spbu.ru" target="_blank">spades.support@cab.spbu.ru</a>.
<br/><br/><br/><br/><br/>
</body>
</html>
|