← Back to branch summary

~ubuntu-branches/ubuntu/trusty/mira/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/docbook/chap_maf_part.xml

  • Committer: Package Import Robot
  • Author(s): Thorsten Alteholz, Thorsten Alteholz, Andreas Tille
  • Date: 2014-02-02 22:51:35 UTC
  • mfrom: (7.1.1 sid)
  • Revision ID: package-import@ubuntu.com-20140202225135-nesemzj59jjgogh0
Tags: 4.0-1
http://bugs.debian.org/735798
[ Thorsten Alteholz ]
* New upstream version 
* debian/rules: add boost dir in auto_configure (Closes: #735798)

[ Andreas Tille ]
* cme fix dpkg-control
* debian/patches/{make.patch,spelling.patch}: applied upstream (thus removed)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/docbook/chap_maf_part.xml
20
20
  <title>The MAF format</title>
21
21
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="warning_frontofchapter.xml"/>
22
22
  <para>
23
 
    This documents describes purpose and format of the MAF format, version 1.
 
23
    This documents describes purpose and format of the MAF format, version
 
24
    1. Which has been superceeded by version 2 but is not described here
 
25
    (yet). But as v1 and v2 are very similar only the notion of readgroups is
 
26
    a big change, I'll let this description live until I have time to update
 
27
    this section.
24
28
  </para>
25
29
  <sect1 id="sect1_introduction:_why_an_own_assembly_format?">
26
30
    <title>
77
81
    </title>
78
82
    <para>
79
83
      This describes version 1 of the MAF format. If the need arises, enhancements
80
 
      like metadata about total number of contigs and reads will be implemented in the
 
84
      like meta-data about total number of contigs and reads will be implemented in the
81
85
      next version.
82
86
    </para>
83
87
    <sect2 id="sect2_basics">
229
233
          </listitem>
230
234
          <listitem>
231
235
            <para>
232
 
              DI <emphasis>character: F or R</emphasis> 
 
236
              DI <emphasis>character: F or R</emphasis>
233
237
            </para>
234
238
            <para> Direction of the read with respect to the
235
239
            template. F for forward, R for reverse.
237
241
          </listitem>
238
242
          <listitem>
239
243
            <para>
240
 
              TF <emphasis>integer: template size from</emphasis> 
 
244
              TF <emphasis>integer: template size from</emphasis>
241
245
            </para>
242
 
            <para> Minimum estimated 
 
246
            <para> Minimum estimated
243
247
            size of a sequencing template. In paired-end sequencing, this is the minimum
244
248
            distance of the read pair.
245
249
            </para>
246
250
          </listitem>
247
251
          <listitem>
248
252
            <para>
249
 
              TT <emphasis>integer: template size to</emphasis> 
 
253
              TT <emphasis>integer: template size to</emphasis>
250
254
            </para>
251
 
            <para> Maximum estimated 
 
255
            <para> Maximum estimated
252
256
            size of a sequencing template. In paired-end sequencing, this is the maximum
253
257
            distance of the read pair.
254
258
            </para>
263
267
          </listitem>
264
268
          <listitem>
265
269
            <para>
266
 
              SL <emphasis>integer: seqvec left</emphasis> 
 
270
              SL <emphasis>integer: seqvec left</emphasis>
267
271
            </para>
268
 
            <para> 
 
272
            <para>
269
273
              Clip left due to sequencing vector. Assumed to be 1 if not
270
274
              present. Note that left clip values are excluding, e.g.: a value
271
275
              of '7' clips off the left 6 bases.
273
277
          </listitem>
274
278
          <listitem>
275
279
            <para>
276
 
              QL <emphasis>integer: qual left</emphasis> 
 
280
              QL <emphasis>integer: qual left</emphasis>
277
281
            </para>
278
 
            <para> 
 
282
            <para>
279
283
              Clip left due to low quality. Assumed to be 1 if not
280
284
              present. Note that left clip values are excluding, e.g.: a value
281
285
              off '7' clips of the left 6 bases.
283
287
          </listitem>
284
288
          <listitem>
285
289
            <para>
286
 
              CL <emphasis>integer: clip left</emphasis> 
 
290
              CL <emphasis>integer: clip left</emphasis>
287
291
            </para>
288
292
            <para>
289
293
              Clip left (any reason). Assumed to be 1 if not present. Note
293
297
          </listitem>
294
298
          <listitem>
295
299
            <para>
296
 
              SR <emphasis>integer: seqvec right</emphasis> 
 
300
              SR <emphasis>integer: seqvec right</emphasis>
297
301
            </para>
298
302
            <para> Clip right due to sequencing
299
303
            vector. Assumed to be the length of the sequence if not present. Note that
303
307
          </listitem>
304
308
          <listitem>
305
309
            <para>
306
 
              QR <emphasis>integer: qual right</emphasis> 
 
310
              QR <emphasis>integer: qual right</emphasis>
307
311
            </para>
308
312
            <para> Clip right due to low quality. Assumed
309
313
            to be the length of the sequence if not present. Note that right clip values
313
317
          </listitem>
314
318
          <listitem>
315
319
            <para>
316
 
              CR <emphasis>integer: clip right</emphasis> 
 
320
              CR <emphasis>integer: clip right</emphasis>
317
321
            </para>
318
322
            <para> Clip right (any reason). Assumed to be
319
323
            the length of the sequence if not present. Note that
323
327
          </listitem>
324
328
          <listitem>
325
329
            <para>
326
 
              AO <emphasis>four integers: x1 y1 x2 y2</emphasis> 
 
330
              AO <emphasis>four integers: x1 y1 x2 y2</emphasis>
327
331
            </para>
328
332
            <para> AO stands for "Align to
329
333
            Original". The interval [x1 y1] in the read as stored in the MAF file aligns
368
372
          </listitem>
369
373
          <listitem>
370
374
            <para>
371
 
              SN <emphasis>string: strain name</emphasis> 
 
375
              SN <emphasis>string: strain name</emphasis>
372
376
            </para>
373
377
            <para> Strain name of the sample that was
374
378
            sequenced, this is a free form string.
376
380
          </listitem>
377
381
          <listitem>
378
382
            <para>
379
 
              MT <emphasis>string: machine type</emphasis> 
 
383
              MT <emphasis>string: machine type</emphasis>
380
384
            </para>
381
385
            <para> Machine type which generated the data,
382
386
            this is a free form string.
384
388
          </listitem>
385
389
          <listitem>
386
390
            <para>
387
 
              BC <emphasis>string: base caller</emphasis> 
 
391
              BC <emphasis>string: base caller</emphasis>
388
392
            </para>
389
393
            <para>
390
394
              Base calling program used to call bases
392
396
          </listitem>
393
397
          <listitem>
394
398
            <para>
395
 
              IB <emphasis>boolean (0 or 1): is backbone</emphasis> 
 
399
              IB <emphasis>boolean (0 or 1): is backbone</emphasis>
396
400
            </para>
397
401
            <para> Whether the read is a backbone. Reads used as reference
398
402
            (backbones) in mapping assemblies get this attribute.
572
576
            so that parsers do not need to perform time consuming string
573
577
            lookups. Every read in a contig has exactly one AT line.
574
578
            </para>
575
 
            <para> The interval 
 
579
            <para> The interval
576
580
            [x2 y2] of the read (i.e., the unclipped data, also called the 'clear range')
577
581
            aligns with the interval [x1 y1] of the contig. If x1 &gt; y1 (the contig
578
582
            positions), then the reverse complement of the read is aligned to the
588
592
          </listitem>
589
593
          <listitem>
590
594
            <para>
591
 
              EC 
 
595
              EC
592
596
            </para>
593
597
            <para> This ends a contig and is mandatory
594
598
            </para>
598
602
    </sect2>
599
603
  </sect1>
600
604
</chapter>
601