annotate align_families.xml @ 3:aedbdf8ce1af draft

planemo upload commit 670b3282d2c120882b956ad617e61369467fb0fe
author nick
date Tue, 08 Dec 2015 08:59:27 -0500
parents ba2a53b970ca
children 7f513b9b1b1e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
1 <?xml version="1.0"?>
2
ba2a53b970ca planemo upload commit 670b3282d2c120882b956ad617e61369467fb0fe
nick
parents: 1
diff changeset
2 <tool id="align_families" name="Du Novo: Align families" version="0.2">
ba2a53b970ca planemo upload commit 670b3282d2c120882b956ad617e61369467fb0fe
nick
parents: 1
diff changeset
3 <description>of duplex sequencing reads</description>
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
4 <requirements>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
5 <requirement type="package" version="7.221">mafft</requirement>
1
b63d6673f883 Bump version number and install from a stable, tagged Github release.
nick
parents: 0
diff changeset
6 <requirement type="package" version="0.2">duplex</requirement>
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
7 <requirement type="set_environment">DUPLEX_DIR</requirement>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
8 </requirements>
3
aedbdf8ce1af planemo upload commit 670b3282d2c120882b956ad617e61369467fb0fe
nick
parents: 2
diff changeset
9 <command detect_errors="exit_code">python \$DUPLEX_DIR/align_families.py -p \${GALAXY_SLOTS:-1} $input &gt; $output
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
10 </command>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
11 <inputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
12 <param name="input" type="data" format="tabular" label="Input reads" help="with barcodes, grouped by family"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
13 </inputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
14 <outputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
15 <data name="output" format="tabular"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
16 </outputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
17 <tests>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
18 <test>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
19 <param name="input" value="smoke.families.tsv"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
20 <output name="output" file="smoke.families.aligned.tsv"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
21 </test>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
22 <test>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
23 <param name="input" value="families.in.tsv"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
24 <output name="output" file="families.sort.tsv"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
25 </test>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
26 </tests>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
27 <help>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
28
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
29 **What it does**
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
30
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
31 This is for processing duplex sequencing data. It does a multiple sequence alignment on each (single-stranded) family of reads.
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
32
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
33 -----
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
34
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
35 **Input**
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
36
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
37 This expects the output format of the "Make families" tool.
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
38
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
39 -----
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
40
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
41 **Output**
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
42
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
43 The output is a tabular file where each line corresponds to a (single) read.
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
44
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
45 The columns are::
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
46
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
47 1: barcode (both tags)
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
48 2: tag order in barcode ("ab" or "ba")
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
49 3: read mate ("1" or "2")
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
50 4: read name
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
51 5: read sequence, aligned ("-" for gaps)
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
52 6: read quality scores, aligned (" " for gaps)
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
53
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
54 -----
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
55
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
56 **Alignments**
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
57
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
58 The alignments are done using MAFFT, specifically the command
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
59 ::
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
60
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
61 $ mafft --nuc --quiet family.fa &gt; family.aligned.fa
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
62
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
63 </help>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
64 </tool>