annotate correct_barcodes.xml @ 22:8ef925264516 draft

planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
author nick
date Fri, 03 Feb 2017 15:37:18 -0500
parents
children 20d78baf0806
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
1 <?xml version="1.0"?>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
2 <tool id="correct_barcodes" name="Du Novo: Correct barcodes" version="0.6">
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
3 <description>of duplex sequencing reads</description>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
4 <requirements>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
5 <requirement type="package" version="2.1.0">bowtie2</requirement>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
6 <requirement type="package" version="0.1.18">samtools</requirement>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
7 <requirement type="package" version="0.6">duplex</requirement>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
8 <requirement type="set_environment">DUPLEX_DIR</requirement>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
9 <!-- TODO: require Python 2.7 -->
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
10 </requirements>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
11 <command detect_errors="exit_code">bash "\$DUPLEX_DIR/baralign.sh" '$input' refdir barcodes.bam
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
12 &amp;&amp; samtools view -f 256 barcodes.bam
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
13 | python "\$DUPLEX_DIR/correct.py" -d $dist -m $mapq -p $pos '$input' refdir/barcodes.fa
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
14 | sort &gt; '$output'
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
15 </command>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
16 <inputs>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
17 <param name="input" type="data" format="tabular" label="Input reads" help="with barcodes, grouped by family"/>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
18 <param name="dist" type="integer" value="1" min="1" label="Maximum edit distance" help="Only use alignments where the barcodes differ by at most these many errors."/>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
19 <param name="mapq" type="integer" value="20" min="0" label="Minimum mapping quality" help="Only use alignments whose MAPQ is at least this."/>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
20 <param name="pos" type="integer" value="2" min="0" label="Minimum start offset" help="Ignore alignments where the start positions differ by more than this."/>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
21 </inputs>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
22 <outputs>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
23 <data name="output" format="tabular"/>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
24 </outputs>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
25 <citations>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
26 <citation type="bibtex">@article{Stoler2016,
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
27 author = {Stoler, Nicholas and Arbeithuber, Barbara and Guiblet, Wilfried and Makova, Kateryna D and Nekrutenko, Anton},
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
28 doi = {10.1186/s13059-016-1039-4},
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
29 issn = {1474-760X},
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
30 journal = {Genome biology},
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
31 number = {1},
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
32 pages = {180},
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
33 pmid = {27566673},
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
34 publisher = {Genome Biology},
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
35 title = {{Streamlined analysis of duplex sequencing data with Du Novo.}},
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
36 url = {http://www.ncbi.nlm.nih.gov/pubmed/27566673},
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
37 volume = {17},
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
38 year = {2016}
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
39 }</citation>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
40 </citations>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
41 <help>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
42
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
43 **What it does**
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
44
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
45 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 bowtie2. This identifies ones which are identical except a few, small differences.
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
46
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
47 -----
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
48
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
49 **Input**
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
50
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
51 This expects the output format of the "Make families" tool.
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
52
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
53 -----
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
54
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
55 **Output**
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
56
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
57 The output format is the same as the input format, ready to be consumed by the "Align families" tool.
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
58
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
59 </help>
8ef925264516 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'3eab56b30cc9d644798a290017bcc1188f028af8\n'-dirty
nick
parents:
diff changeset
60 </tool>