annotate duplex.xml @ 15:ba81823ad9e1 draft

planemo upload commit 670b3282d2c120882b956ad617e61369467fb0fe
author nick
date Tue, 08 Dec 2015 08:57:34 -0500
parents 117b0072189d
children
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"?>
14
117b0072189d planemo upload commit 670b3282d2c120882b956ad617e61369467fb0fe
nick
parents: 11
diff changeset
2 <tool id="duplex" name="Du Novo: Make consensus reads" version="0.2">
117b0072189d planemo upload commit 670b3282d2c120882b956ad617e61369467fb0fe
nick
parents: 11
diff changeset
3 <description>from duplex sequencing alignments</description>
5
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
4 <requirements>
11
678dd4b4b4e7 planemo upload commit 5781eaed740d053eabb52d06689dce19be189bc0-dirty
nick
parents: 10
diff changeset
5 <requirement type="package" version="0.2">duplex</requirement>
8
e504cc1d5a76 planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents: 5
diff changeset
6 <requirement type="set_environment">DUPLEX_DIR</requirement>
5
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
7 </requirements>
9
f6f61b363467 planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents: 8
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
f6f61b363467 planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents: 8
diff changeset
9 python \$DUPLEX_DIR/duplex.py -r $min_reads -q $qual_thres -F $qual_format $input
5
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
10 #if $keep_sscs:
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
11 --sscs-file $sscs
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
12 #end if
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
13 > duplex.fa
8
e504cc1d5a76 planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents: 5
diff changeset
14 && awk -f \$DUPLEX_DIR/utils/outconv.awk -v target=1 duplex.fa > $output1
e504cc1d5a76 planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents: 5
diff changeset
15 && awk -f \$DUPLEX_DIR/utils/outconv.awk -v target=2 duplex.fa > $output2
5
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
16 ]]>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
17 </command>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
18 <inputs>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
19 <param name="input" type="data" format="tabular" label="Aligned input reads" />
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
20 <param name="min_reads" type="integer" value="3" min="1" label="Minimum reads per family" help="Single-strand families with fewer than this many reads will be skipped."/>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
21 <param name="qual_thres" type="integer" value="25" min="1" label="Minimum base quality" help="Bases with a PHRED score less than this will not be counted in the consensus making."/>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
22 <param name="qual_format" type="select" label="FASTQ format" help="Solexa should also work for Illumina 1.3+ and 1.5+, and Sanger should work for Illumina 1.8+">
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
23 <option value="sanger" selected="true">Sanger (PHRED 0 = &quot;!&quot;)</option>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
24 <option value="solexa">Solexa (PHRED 0 = &quot;@&quot;)</option>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
25 </param>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
26 <param name="keep_sscs" type="boolean" truevalue="true" falsevalue="" label="Output single-strand consensus sequences" />
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
27 </inputs>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
28 <outputs>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
29 <data name="output1" format="fasta" label="$tool.name on $on_string (mate 1)"/>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
30 <data name="output2" format="fasta" label="$tool.name on $on_string (mate 2)"/>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
31 <data name="sscs" format="fasta" label="$tool.name on $on_string (SSCS)">
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
32 <filter>keep_sscs</filter>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
33 </data>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
34 </outputs>
10
ffd06de5cea9 planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents: 9
diff changeset
35 <tests>
ffd06de5cea9 planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents: 9
diff changeset
36 <test>
ffd06de5cea9 planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents: 9
diff changeset
37 <param name="input" value="families.msa.tsv"/>
ffd06de5cea9 planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents: 9
diff changeset
38 <output name="output1" file="families.cons_1.fa"/>
ffd06de5cea9 planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents: 9
diff changeset
39 <output name="output2" file="families.cons_2.fa"/>
ffd06de5cea9 planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents: 9
diff changeset
40 </test>
ffd06de5cea9 planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents: 9
diff changeset
41 </tests>
5
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
42 <help>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
43
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
44 **What it does**
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
45
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
46 This is for processing duplex sequencing data. It creates single-strand and duplex consensus reads from aligned read families.
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
47
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
48 -----
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
49
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
50 **Input**
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
51
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
52 This expects the output format of the "Align families" tool.
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 **Output**
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
57
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
58 This will output final, duplex consensus reads in two FASTA files (first and second reads in the pairs). Optionally, you can save the single-strand reads too, in a separate FASTA file.
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
59
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
60 </help>
9d46c9ca7ceb planemo upload commit 022984f323d3da44f70b3bf79c684cfd8dda3f61-dirty
nick
parents:
diff changeset
61 </tool>