annotate correct_barcodes.xml @ 10:9dc43bf7d1db draft

planemo upload for repository https://github.com/galaxyproject/dunovo commit b'230f018da2c0bc4eedc72e0f70eac0df1e85ebdb\n'-dirty
author nick
date Fri, 01 Jun 2018 17:55:23 -0400
parents fa563fa9b330
children 0f8e0dc73d1d
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"?>
10
9dc43bf7d1db planemo upload for repository https://github.com/galaxyproject/dunovo commit b'230f018da2c0bc4eedc72e0f70eac0df1e85ebdb\n'-dirty
nick
parents: 9
diff changeset
2 <tool id="correct_barcodes" name="Du Novo: Correct barcodes" version="2.15">
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
3 <description>of duplex sequencing reads</description>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
4 <requirements>
8
658eefb99fd7 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'7d364d2b3f4fd9a7787165a883efa122b326d4c2\n'-dirty
nick
parents: 7
diff changeset
5 <requirement type="package" version="1.1.2">bowtie</requirement>
6
23f5d9316694 Bugfix in kalign for very diverse read lengths.
nick
parents: 5
diff changeset
6 <requirement type="package" version="1.10">networkx</requirement>
10
9dc43bf7d1db planemo upload for repository https://github.com/galaxyproject/dunovo commit b'230f018da2c0bc4eedc72e0f70eac0df1e85ebdb\n'-dirty
nick
parents: 9
diff changeset
7 <requirement type="package" version="2.15">dunovo</requirement>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
8 <!-- TODO: require Python 2.7 -->
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
9 </requirements>
5
000969829a5d correct.py wrapper fix
nick
parents: 4
diff changeset
10 <version_command>correct.py --version</version_command>
2
a9cb6fb9ea94 Update to Du Novo 0.7.6.
nick
parents: 1
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
8
658eefb99fd7 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'7d364d2b3f4fd9a7787165a883efa122b326d4c2\n'-dirty
nick
parents: 7
diff changeset
12 baralign.sh -c $advanced.chunkmbs -t \${GALAXY_SLOTS:-1} '$input' refdir correct.sam
10
9dc43bf7d1db planemo upload for repository https://github.com/galaxyproject/dunovo commit b'230f018da2c0bc4eedc72e0f70eac0df1e85ebdb\n'-dirty
nick
parents: 9
diff changeset
13 && correct.py --galaxy $phone $check_ids --dist $dist --mapq $mapq --pos $pos
8
658eefb99fd7 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'7d364d2b3f4fd9a7787165a883efa122b326d4c2\n'-dirty
nick
parents: 7
diff changeset
14 '$input' refdir/barcodes.fa correct.sam
5
000969829a5d correct.py wrapper fix
nick
parents: 4
diff changeset
15 > families.corrected.tsv
000969829a5d correct.py wrapper fix
nick
parents: 4
diff changeset
16 && sort families.corrected.tsv
000969829a5d correct.py wrapper fix
nick
parents: 4
diff changeset
17 > '$output'
2
a9cb6fb9ea94 Update to Du Novo 0.7.6.
nick
parents: 1
diff changeset
18 ]]>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
19 </command>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
20 <inputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
21 <param name="input" type="data" format="tabular" label="Input reads" help="with barcodes, grouped by family"/>
9
fa563fa9b330 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'74b84167148cb0a0d7c6ac83123e8c957f85fe37\n'-dirty
nick
parents: 8
diff changeset
22 <param name="dist" type="integer" value="3" min="1" label="Maximum differences" help="Only use alignments where the barcodes differ by at most these many errors. Note that raising this beyond 3 probably won't have an effect, because of the inherent limit in bowtie's ability to match up distant barcodes."/>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
23 <param name="mapq" type="integer" value="20" min="0" label="Minimum mapping quality" help="Only use alignments whose MAPQ is at least this."/>
8
658eefb99fd7 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'7d364d2b3f4fd9a7787165a883efa122b326d4c2\n'-dirty
nick
parents: 7
diff changeset
24 <param name="pos" type="integer" value="2" min="0" label="Maximum start offset" help="Ignore alignments where the start positions differ by more than this."/>
10
9dc43bf7d1db planemo upload for repository https://github.com/galaxyproject/dunovo commit b'230f018da2c0bc4eedc72e0f70eac0df1e85ebdb\n'-dirty
nick
parents: 9
diff changeset
25 <param name="check_ids" type="boolean" truevalue="" falsevalue="--no-check-ids" checked="True" label="Check read names" help="Make sure reads are properly paired up. The job will fail if there is a pair of reads where their ids aren't identical (minus any ending /1 or /2)."/>
4
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
26 <param name="phone" type="boolean" truevalue="--phone-home" falsevalue="" checked="False" label="Send 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 and memory taken to process it, and the IP address of the machine running it. Also, if the tool fails, it will report the name of the exception thrown and the line of code it occurred in. The parameters and input/output dataset names are not sent. All the reporting and recording code is available at https://github.com/NickSto/ET"/>
8
658eefb99fd7 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'7d364d2b3f4fd9a7787165a883efa122b326d4c2\n'-dirty
nick
parents: 7
diff changeset
27 <section name="advanced" title="Advanced Options" expanded="false">
658eefb99fd7 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'7d364d2b3f4fd9a7787165a883efa122b326d4c2\n'-dirty
nick
parents: 7
diff changeset
28 <param name="chunkmbs" type="integer" value="512" min="16" label="bowtie --chunkmbs" help="This is the number of megabytes to give each bowtie thread for storing path descriptors. If you see warnings about &quot;Exhausted best-first chunk memory&quot; in stderr, you need to increase this."/>
658eefb99fd7 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'7d364d2b3f4fd9a7787165a883efa122b326d4c2\n'-dirty
nick
parents: 7
diff changeset
29 </section>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
30 </inputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
31 <outputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
32 <data name="output" format="tabular"/>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
33 </outputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
34 <help>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
35
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
36 **What it does**
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
37
8
658eefb99fd7 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'7d364d2b3f4fd9a7787165a883efa122b326d4c2\n'-dirty
nick
parents: 7
diff changeset
38 This is for processing duplex sequencing data. This will correct duplex barcodes and create new, larger families. Errors in barcodes normally prevent them from being recognized as the same as the other barcodes in their family. Correcting these errors allows the original, full families to be reconstructed, saving reads which would otherwise be lost. This tool accomplishes this by doing an all vs. all alignment between the barcodes with bowtie. This identifies ones which are identical except a few, small differences.
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
39
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
40 -----
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
41
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
42 **Input**
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
43
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
44 This expects the output format of the "Make families" tool.
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
45
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
46 -----
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
47
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
48 **Output**
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
49
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
50 The output format is the same as the input format, ready to be consumed by the "Align families" tool.
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
51
4
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
52 </help>
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
53 <citations>
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
54 <citation type="bibtex">@article{Stoler2016,
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
55 author = {Stoler, Nicholas and Arbeithuber, Barbara and Guiblet, Wilfried and Makova, Kateryna D and Nekrutenko, Anton},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
56 doi = {10.1186/s13059-016-1039-4},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
57 issn = {1474-760X},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
58 journal = {Genome biology},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
59 number = {1},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
60 pages = {180},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
61 pmid = {27566673},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
62 publisher = {Genome Biology},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
63 title = {{Streamlined analysis of duplex sequencing data with Du Novo.}},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
64 url = {http://www.ncbi.nlm.nih.gov/pubmed/27566673},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
65 volume = {17},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
66 year = {2016}
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
67 }</citation>
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
68 </citations>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
69 </tool>