annotate dunovo.xml @ 21:53cf867b305b draft

planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
author nick
date Thu, 02 Feb 2017 19:50:18 -0500
parents 675a8370675b
children 8ef925264516
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
1 <?xml version="1.0"?>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
2 <tool id="duplex" name="Du Novo: Make consensus reads" version="0.5">
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
3 <description>from duplex sequencing alignments</description>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
4 <requirements>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
5 <requirement type="package" version="0.5">duplex</requirement>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
6 <requirement type="set_environment">DUPLEX_DIR</requirement>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
7 <!-- TODO: require Python 2.7 -->
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
8 </requirements>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
10 python "\$DUPLEX_DIR/dunovo.py" -r $min_reads -q $qual_thres -F $qual_format '$input'
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
11 #if $keep_sscs:
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
12 --sscs-file sscs.fa
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
13 #end if
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
14 > duplex.fa
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
15 && python "\$DUPLEX_DIR/utils/outconv.py" duplex.fa -1 '$dcs1' -2 '$dcs2'
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
16 #if $keep_sscs:
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
17 && python "\$DUPLEX_DIR/utils/outconv.py" sscs.fa -1 '$sscs1' -2 '$sscs2'
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
18 #end if
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
19 ]]>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
20 </command>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
21 <inputs>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
22 <param name="input" type="data" format="tabular" label="Aligned input reads" />
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
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."/>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
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."/>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
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+">
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
26 <option value="sanger" selected="true">Sanger (PHRED 0 = &quot;!&quot;)</option>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
27 <option value="solexa">Solexa (PHRED 0 = &quot;@&quot;)</option>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
28 </param>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
29 <param name="keep_sscs" type="boolean" truevalue="true" falsevalue="" label="Output single-strand consensus sequences as well" />
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
30 </inputs>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
31 <outputs>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
32 <data name="dcs1" format="fasta" label="$tool.name on $on_string (mate 1)"/>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
33 <data name="dcs2" format="fasta" label="$tool.name on $on_string (mate 2)"/>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
34 <data name="sscs1" format="fasta" label="$tool.name on $on_string (SSCS mate 1)">
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
35 <filter>keep_sscs</filter>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
36 </data>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
37 <data name="sscs2" format="fasta" label="$tool.name on $on_string (SSCS mate 2)">
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
38 <filter>keep_sscs</filter>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
39 </data>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
40 </outputs>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
41 <tests>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
42 <test>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
43 <param name="input" value="families.msa.tsv"/>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
44 <output name="dcs1" file="families.cons_1.fa"/>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
45 <output name="dcs2" file="families.cons_2.fa"/>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
46 </test>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
47 </tests>
21
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
48 <citations>
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
49 <citation type="bibtex">@article{Stoler2016,
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
50 author = {Stoler, Nicholas and Arbeithuber, Barbara and Guiblet, Wilfried and Makova, Kateryna D and Nekrutenko, Anton},
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
51 doi = {10.1186/s13059-016-1039-4},
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
52 issn = {1474-760X},
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
53 journal = {Genome biology},
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
54 number = {1},
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
55 pages = {180},
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
56 pmid = {27566673},
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
57 publisher = {Genome Biology},
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
58 title = {{Streamlined analysis of duplex sequencing data with Du Novo.}},
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
59 url = {http://www.ncbi.nlm.nih.gov/pubmed/27566673},
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
60 volume = {17},
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
61 year = {2016}
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
62 }</citation>
53cf867b305b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'a67987d921c6ee2f042597ba46b34dfbd86f415e\n'-dirty
nick
parents: 19
diff changeset
63 </citations>
19
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
64 <help>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
65
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
66 **What it does**
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
67
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
68 This is for processing duplex sequencing data. It creates single-strand and duplex consensus reads from aligned read families.
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
69
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
70 -----
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
71
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
72 **Input**
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
73
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
74 This expects the output format of the "Align families" tool.
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
75
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
76 -----
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
77
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
78 **Output**
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
79
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
80 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.
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
81
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
82 </help>
675a8370675b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4303231da9e48b2719b4429a29b72421d24310f4\n'-dirty
nick
parents:
diff changeset
83 </tool>