Mercurial > repos > jjohnson > fgbio_sort_bam

annotate macros.xml @ 1:cb58d1961fd3 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
author jjohnson
date Wed, 24 Feb 2021 13:02:43 +0000
parents 286e35cf3f1c
children f8798f04ac47
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
1 <macros>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
2 <token name="@TOOL_VERSION@">1.3.0</token>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
3 <token name="@VERSION_SUFFIX@">0</token>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
4 <xml name="requirements">
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
5 <requirements>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
6 <requirement type="package" version="@TOOL_VERSION@">fgbio</requirement>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
7 <yield/>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
8 </requirements>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
9 </xml>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
10 <token name="@READ_STRUCTURE_PATTERN@">(([1-9][0-9]*[TBMS])*([+]|[1-9][0-9]*)[TBMS])</token>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
11 <token name="@READ_STRUCTURES_PATTERN@">@READ_STRUCTURE_PATTERN@(\s@READ_STRUCTURE_PATTERN@)*</token>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
12 <xml name="read_structures_validator">
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
13 <validator type="regex" message="">^@READ_STRUCTURES_PATTERN@$</validator>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
14 </xml>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
15 <xml name="sam_tag_validator">
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
16 <validator type="regex" message="">^[A-Za-z][A-Za-z]$</validator>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
17 </xml>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
18 <xml name="sam_sort_order">
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
19 <param argument="--sort-order" type="select" optional="true" label="Sort BAM by">
1
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
20 <option value="TemplateCoordinate">TemplateCoordinate</option>
0
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
21 <option value="Coordinate">Coordinate</option>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
22 <option value="Queryname">Queryname</option>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
23 <option value="Random">Random</option>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
24 <option value="RandomQuery">RandomQuery</option>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
25 </param>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
26 </xml>
1
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
27
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
28 <xml name="sort_order_change_format">
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
29 <change_format>
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
30 <when input="sort_order" value="Coordinate" format="bam" />
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
31 <when input="sort_order" value="TemplateCoordinate" format="bam" />
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
32 <when input="sort_order" value="QueryName" format="unsorted.bam" />
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
33 <when input="sort_order" value="Random" format="unsorted.bam" />
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
34 <when input="sort_order" value="RandomQuery" format="unsorted.bam" />
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
35 </change_format>
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
36 </xml>
0
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
37
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
38 <token name="@READ_STRUCTURES_HELP@"><![CDATA[
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
39 **Read Structures**
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
40
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
41 Read structures are made up of <number><operator> pairs much like the CIGAR string in BAM files. Four kinds of operators are recognized:
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
42
1
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
43 - T identifies a template read
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
44 - B identifies a sample barcode read
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
45 - M identifies a unique molecular index read
cb58d1961fd3 "planemo upload commit 692ea558cbbefee93859dc2b005fab5ac4970eb8"
jjohnson
parents: 0
diff changeset
46 - S identifies a set of bases that should be skipped or ignored
0
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
47
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
48 The last <number><operator> pair may be specified using a + sign instead of number to denote “all remaining bases”. This is useful if, e.g., fastqs have been trimmed and contain reads of varying length. For example to convert a paired-end run with an index read and where the first 5 bases of R1 are a UMI and the second five bases are monotemplate you might specify:
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
49
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
50 ::
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
51
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
52 --input r1.fq r2.fq i1.fq --read-structures 5M5S+T +T +B
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
53
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
54 Alternative if you know your reads are of fixed length you could specify:
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
55
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
56 ::
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
57
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
58 --input r1.fq r2.fq i1.fq --read-structures 5M5S65T 75T 8B
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
59
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
60
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
61 ]]></token>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
62 <xml name="citations">
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
63 <citations>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
64 <yield />
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
65 </citations>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
66 </xml>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
67 </macros>