annotate align_families.xml @ 10:ffd06de5cea9 draft

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