annotate duplex.xml @ 1:b63d6673f883 draft

Bump version number and install from a stable, tagged Github release.
author nick
date Mon, 23 Nov 2015 22:53:35 -0500
parents d2e46adc199e
children ba2a53b970ca
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"?>
1
b63d6673f883 Bump version number and install from a stable, tagged Github release.
nick
parents: 0
diff changeset
2 <tool id="duplex" name="Make consensus reads" version="0.2">
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
3 <description>from duplex sequencing data</description>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
4 <requirements>
1
b63d6673f883 Bump version number and install from a stable, tagged Github release.
nick
parents: 0
diff changeset
5 <requirement type="package" version="0.2">duplex</requirement>
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
6 <requirement type="set_environment">DUPLEX_DIR</requirement>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
7 </requirements>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
9 python \$DUPLEX_DIR/duplex.py -r $min_reads -q $qual_thres -F $qual_format $input
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
10 #if $keep_sscs:
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
11 --sscs-file $sscs
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
12 #end if
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
13 > duplex.fa
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
14 && awk -f \$DUPLEX_DIR/utils/outconv.awk -v target=1 duplex.fa > $output1
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
15 && awk -f \$DUPLEX_DIR/utils/outconv.awk -v target=2 duplex.fa > $output2
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
16 ]]>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
17 </command>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
18 <inputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
19 <param name="input" type="data" format="tabular" label="Aligned input reads" />
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
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."/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
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."/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
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+">
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
23 <option value="sanger" selected="true">Sanger (PHRED 0 = &quot;!&quot;)</option>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
24 <option value="solexa">Solexa (PHRED 0 = &quot;@&quot;)</option>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
25 </param>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
26 <param name="keep_sscs" type="boolean" truevalue="true" falsevalue="" label="Output single-strand consensus sequences" />
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
27 </inputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
28 <outputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
29 <data name="output1" format="fasta" label="$tool.name on $on_string (mate 1)"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
30 <data name="output2" format="fasta" label="$tool.name on $on_string (mate 2)"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
31 <data name="sscs" format="fasta" label="$tool.name on $on_string (SSCS)">
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
32 <filter>keep_sscs</filter>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
33 </data>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
34 </outputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
35 <tests>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
36 <test>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
37 <param name="input" value="families.msa.tsv"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
38 <output name="output1" file="families.cons_1.fa"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
39 <output name="output2" file="families.cons_2.fa"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
40 </test>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
41 </tests>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
42 <help>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
43
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
44 **What it does**
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
45
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
46 This is for processing duplex sequencing data. It creates single-strand and duplex consensus reads from aligned read families.
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
47
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
48 -----
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
49
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
50 **Input**
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
51
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
52 This expects the output format of the "Align families" tool.
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 **Output**
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
57
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
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.
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
59
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
60 </help>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
61 </tool>