annotate dunovo.xml @ 4:7f513b9b1b1e draft

Change names to dunovo, use newer Github release.
author nick
date Mon, 21 Dec 2015 14:47:48 -0500
parents
children 4bc49a5769ee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
1 <?xml version="1.0"?>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
2 <tool id="duplex" name="Du Novo: Make consensus reads" version="0.3">
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
3 <description>from duplex sequencing alignments</description>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
4 <requirements>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
5 <requirement type="package" version="0.3">duplex</requirement>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
6 <requirement type="set_environment">DUPLEX_DIR</requirement>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
7 <!-- TODO: require Python 2.7 -->
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
8 </requirements>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
10 python \$DUPLEX_DIR/dunovo.py -r $min_reads -q $qual_thres -F $qual_format $input
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
11 #if $keep_sscs:
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
12 --sscs-file $sscs
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
13 #end if
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
14 > duplex.fa
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
15 && awk -f \$DUPLEX_DIR/utils/outconv.awk -v target=1 duplex.fa > $output1
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
16 && awk -f \$DUPLEX_DIR/utils/outconv.awk -v target=2 duplex.fa > $output2
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
17 ]]>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
18 </command>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
19 <inputs>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
20 <param name="input" type="data" format="tabular" label="Aligned input reads" />
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
21 <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."/>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
22 <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."/>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
23 <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+">
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
24 <option value="sanger" selected="true">Sanger (PHRED 0 = &quot;!&quot;)</option>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
25 <option value="solexa">Solexa (PHRED 0 = &quot;@&quot;)</option>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
26 </param>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
27 <param name="keep_sscs" type="boolean" truevalue="true" falsevalue="" label="Output single-strand consensus sequences" />
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
28 </inputs>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
29 <outputs>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
30 <data name="output1" format="fasta" label="$tool.name on $on_string (mate 1)"/>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
31 <data name="output2" format="fasta" label="$tool.name on $on_string (mate 2)"/>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
32 <data name="sscs" format="fasta" label="$tool.name on $on_string (SSCS)">
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
33 <filter>keep_sscs</filter>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
34 </data>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
35 </outputs>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
36 <tests>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
37 <test>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
38 <param name="input" value="families.msa.tsv"/>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
39 <output name="output1" file="families.cons_1.fa"/>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
40 <output name="output2" file="families.cons_2.fa"/>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
41 </test>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
42 </tests>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
43 <help>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
44
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
45 **What it does**
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
46
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
47 This is for processing duplex sequencing data. It creates single-strand and duplex consensus reads from aligned read families.
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
48
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
49 -----
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
50
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
51 **Input**
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
52
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
53 This expects the output format of the "Align families" tool.
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
54
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
55 -----
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
56
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
57 **Output**
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
58
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
59 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.
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
60
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
61 </help>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
62 </tool>