annotate dunovo.xml @ 5:4bc49a5769ee draft

Version 0.5: Split interleaved SSCS output file into two paired files.
author nick
date Thu, 01 Dec 2016 23:22:52 -0500
parents 7f513b9b1b1e
children 9a0bee12b583
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"?>
5
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
2 <tool id="duplex" name="Du Novo: Make consensus reads" version="0.5">
4
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>
5
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
5 <requirement type="package" version="0.5">duplex</requirement>
4
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:
5
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
12 --sscs-file sscs.fa
4
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
5
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
15 && python \$DUPLEX_DIR/utils/outconv.py duplex.fa -1 $dcs1 -2 $dcs2
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
16 #if $keep_sscs:
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
17 && python \$DUPLEX_DIR/utils/outconv.py sscs.fa -1 $sscs1 -2 $sscs2
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
18 #end if
4
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
19 ]]>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
20 </command>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
21 <inputs>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
22 <param name="input" type="data" format="tabular" label="Aligned input reads" />
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
23 <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
24 <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
25 <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
26 <option value="sanger" selected="true">Sanger (PHRED 0 = &quot;!&quot;)</option>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
27 <option value="solexa">Solexa (PHRED 0 = &quot;@&quot;)</option>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
28 </param>
5
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
29 <param name="keep_sscs" type="boolean" truevalue="true" falsevalue="" label="Output single-strand consensus sequences as well" />
4
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
30 </inputs>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
31 <outputs>
5
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
32 <data name="dcs1" format="fasta" label="$tool.name on $on_string (mate 1)"/>
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
33 <data name="dcs2" format="fasta" label="$tool.name on $on_string (mate 2)"/>
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
34 <data name="sscs1" format="fasta" label="$tool.name on $on_string (SSCS mate 1)">
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
35 <filter>keep_sscs</filter>
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
36 </data>
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
37 <data name="sscs2" format="fasta" label="$tool.name on $on_string (SSCS mate 2)">
4
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
38 <filter>keep_sscs</filter>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
39 </data>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
40 </outputs>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
41 <tests>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
42 <test>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
43 <param name="input" value="families.msa.tsv"/>
5
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
44 <output name="dcs1" file="families.cons_1.fa"/>
4bc49a5769ee Version 0.5: Split interleaved SSCS output file into two paired files.
nick
parents: 4
diff changeset
45 <output name="dcs2" file="families.cons_2.fa"/>
4
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
46 </test>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
47 </tests>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
48 <help>
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 **What it does**
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
51
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
52 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
53
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 **Input**
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
57
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
58 This expects the output format of the "Align families" tool.
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
59
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
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
62 **Output**
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
63
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
64 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
65
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
66 </help>
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents:
diff changeset
67 </tool>