annotate dunovo.xml @ 3:00dde366870a draft

planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a3ad9fbb3f010253808fc0c7329897a741ec9feb\n'
author nick
date Mon, 11 Sep 2017 16:59:44 -0400
parents a9cb6fb9ea94
children 5fbeaa41b223
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
1 <?xml version="1.0"?>
3
00dde366870a planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a3ad9fbb3f010253808fc0c7329897a741ec9feb\n'
nick
parents: 2
diff changeset
2 <tool id="dunovo" name="Du Novo: Make consensus reads" version="0.8.1">
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
3 <description>from duplex sequencing alignments</description>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
4 <requirements>
3
00dde366870a planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a3ad9fbb3f010253808fc0c7329897a741ec9feb\n'
nick
parents: 2
diff changeset
5 <requirement type="package" version="0.8.1">dunovo</requirement>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
6 <!-- TODO: require Python 2.7 -->
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
7 </requirements>
3
00dde366870a planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a3ad9fbb3f010253808fc0c7329897a741ec9feb\n'
nick
parents: 2
diff changeset
8 <command detect_errors="exit_code">
00dde366870a planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a3ad9fbb3f010253808fc0c7329897a741ec9feb\n'
nick
parents: 2
diff changeset
9 dunovo.py --galaxy $phone --processes \${GALAXY_SLOTS:-1} --min-reads $min_reads --qual $qual_thres --qual-format $qual_format --cons-thres $cons_thres --min-cons-reads $min_cons_reads '$input' --dcs1 '$dcs1' --dcs2 '$dcs2'
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
10 #if $keep_sscs:
3
00dde366870a planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a3ad9fbb3f010253808fc0c7329897a741ec9feb\n'
nick
parents: 2
diff changeset
11 --sscs1 '$sscs1' --sscs2 '$sscs2'
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
12 #end if
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
13 </command>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
14 <inputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
15 <param name="input" type="data" format="tabular" label="Aligned input reads" />
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
16 <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."/>
3
00dde366870a planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a3ad9fbb3f010253808fc0c7329897a741ec9feb\n'
nick
parents: 2
diff changeset
17 <param name="cons_thres" type="float" value="0.5" min="0.5" max="1.0" label="The threshold to use when making consensus sequences. The consensus base must be present in more than this fraction of the reads, or &quot;N&quot; will be used."/>
00dde366870a planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a3ad9fbb3f010253808fc0c7329897a741ec9feb\n'
nick
parents: 2
diff changeset
18 <param name="min_cons_reads" type="integer" value="0" min="0" label="The minimum number of reads a base must appear in to be used as the consensus base. If no base at the position appears in at least this many reads, &quot;N&quot; will be used."/>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
19 <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."/>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
20 <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+">
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
21 <option value="sanger" selected="true">Sanger (PHRED 0 = &quot;!&quot;)</option>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
22 <option value="solexa">Solexa (PHRED 0 = &quot;@&quot;)</option>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
23 </param>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
24 <param name="keep_sscs" type="boolean" truevalue="true" falsevalue="" label="Output single-strand consensus sequences as well" />
2
a9cb6fb9ea94 Update to Du Novo 0.7.6.
nick
parents: 1
diff changeset
25 <param name="phone" type="boolean" truevalue="--phone-home" falsevalue="" checked="False" label="Send anonymous usage data" help="Report helpful usage data to the developer, to better understand the use cases and performance of the tool. The only data which will be recorded is the name and version of the tool, the size of the input data, the time taken to process it, and the IP address of the machine running it. No parameters or filenames are sent."/>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
26 </inputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
27 <outputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
28 <data name="dcs1" format="fasta" label="$tool.name on $on_string (mate 1)"/>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
29 <data name="dcs2" format="fasta" label="$tool.name on $on_string (mate 2)"/>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
30 <data name="sscs1" format="fasta" label="$tool.name on $on_string (SSCS mate 1)">
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
31 <filter>keep_sscs</filter>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
32 </data>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
33 <data name="sscs2" format="fasta" label="$tool.name on $on_string (SSCS mate 2)">
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
34 <filter>keep_sscs</filter>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
35 </data>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
36 </outputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
37 <tests>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
38 <test>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
39 <param name="input" value="families.msa.tsv"/>
3
00dde366870a planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a3ad9fbb3f010253808fc0c7329897a741ec9feb\n'
nick
parents: 2
diff changeset
40 <output name="dcs1" file="families.dcs_1.fa"/>
00dde366870a planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a3ad9fbb3f010253808fc0c7329897a741ec9feb\n'
nick
parents: 2
diff changeset
41 <output name="dcs2" file="families.dcs_2.fa"/>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
42 </test>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
43 </tests>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
44 <citations>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
45 <citation type="bibtex">@article{Stoler2016,
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
46 author = {Stoler, Nicholas and Arbeithuber, Barbara and Guiblet, Wilfried and Makova, Kateryna D and Nekrutenko, Anton},
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
47 doi = {10.1186/s13059-016-1039-4},
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
48 issn = {1474-760X},
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
49 journal = {Genome biology},
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
50 number = {1},
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
51 pages = {180},
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
52 pmid = {27566673},
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
53 publisher = {Genome Biology},
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
54 title = {{Streamlined analysis of duplex sequencing data with Du Novo.}},
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
55 url = {http://www.ncbi.nlm.nih.gov/pubmed/27566673},
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
56 volume = {17},
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
57 year = {2016}
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
58 }</citation>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
59 </citations>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
60 <help>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
61
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
62 **What it does**
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
63
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
64 This is for processing duplex sequencing data. It creates single-strand and duplex consensus reads from aligned read families.
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
65
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
66 -----
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
67
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
68 **Input**
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
69
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
70 This expects the output format of the "Align families" tool.
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
71
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
72 -----
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
73
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
74 **Output**
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
75
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
76 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.
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
77
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
78 </help>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
79 </tool>