annotate mismatch_frequencies.xml @ 2:2974c382105c draft default tip

planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
author mvdbeek
date Sat, 22 Dec 2018 04:15:47 -0500
parents 3613460e891e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
3613460e891e planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 0beb86e6a562c0dad52afdc0f047b3887ad9ce8e-dirty
mvdbeek
parents: 0
diff changeset
1 <tool id="mismatch_frequencies" name="Mismatch Frequencies" version="0.1.0" hidden="false" >
0
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
2 <description>Analyze mismatch frequencies in BAM/SAM alignments</description>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
3 <requirements>
2
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
4 <requirement type="package" version="0.8.3">pysam</requirement>
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
5 <requirement type="package" version="0.19.0">pandas</requirement>
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
6 <requirement type="package" version="1.5.3">matplotlib</requirement>
0
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
7 </requirements>
2
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
9 python '$__tool_directory__'/mismatch_frequencies.py --input
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
10 #for i in $rep
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
11 "$i.input_file"
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
12 #end for
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
13 --name
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
14 #for i in $rep
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
15 "$i.input_file.element_identifier"
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
16 #end for
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
17 --output_pdf '$output_pdf'
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
18 --output_tab '$output_tab'
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
19 --min $min_length
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
20 --max $max_length
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
21 --n_mm $number_of_mismatches
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
22 --five_p $five_p
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
23 --three_p $three_p
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
24 --expanded_output_tab '$expanded_tab'
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
25 --possible_mismatches $possible_mismatches
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
26 ]]></command>
0
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
27 <inputs>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
28 <repeat name="rep" title="alignment files">
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
29 <param name="input_file" type="data" format="bam,sam" label="Alignment file" help="The input alignment file(s) for which to analyze the mismatches."/>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
30 </repeat>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
31 <param name="number_of_mismatches" label="Maximum number of allowed mismatches per read" help="Discard reads with more than the chosen number of mismatches from the frequency calculation" type="integer" value="3"/>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
32 <param name="possible_mismatches" label="Specify mismatches that should be counted" help="Ignores mismatches that are not listed" type="text" value="AC AG AT CA CG CT GA GC GT TA TC TG">
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
33 <validator type="expression" message="Allowed values are AGCTN, seperated by space.">len([False for char in value if not char in " AGCTN"]) == 0</validator>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
34 </param>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
35 <param name="min_length" label="Minumum read length to analyse" type="integer" value="21"/>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
36 <param name="max_length" label="Maximum read length to analyse" type="integer" value="21"/>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
37 <param name="five_p" label="Ignore mismatches in the first N nucleotides of a read" type="integer" value="0"/>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
38 <param name="three_p" label="Ignore mismatches in the last N nucleotides of a read" help="useful to discriminate between tailing events and editing events" type="integer" value="3"/>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
39 <param help="Output expanded tabular format" label="Nucleotide mismatches per reference sequence" name="expanded" type="select">
2
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
40 <option selected="true" value="false">No</option>
0
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
41 <option value="expanded">Yes</option>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
42 </param>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
43 </inputs>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
44 <outputs>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
45 <data format="tabular" name="output_tab" />
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
46 <data format="tabular" name="expanded_tab">
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
47 <filter> expanded == "expanded"</filter>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
48 </data>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
49 <data format="pdf" name="output_pdf" />
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
50 </outputs>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
51 <tests>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
52 <test>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
53 <param name="rep_0|input_file" value="3mismatches_ago2ip_s2.bam" ftype="bam" />
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
54 <param name="rep_1|input_file" value="3mismatches_ago2ip_ovary.bam" ftype="bam" />
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
55 <param name="number_of_mismatches" value="1" />
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
56 <param name="min_length" value="21" />
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
57 <param name="max_length" value="21" />
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
58 <param name="three_p" value="0" />
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
59 <param name="five_p" value="0" />
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
60 <output name="tabular" file="mismatch.tab" ftype="tabular"/>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
61 <!--
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
62 <output name="pdf" file="mismatch.pdf" ftype="pdf"/>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
63 -->
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
64 </test>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
65 </tests>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
66 <help>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
67
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
68 .. class:: infomark
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
69
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
70
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
71 ***What it does***
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
72
2
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
73 This tool reconstitues for each aligned read of an alignment file in SAM/BAM
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
74 format whether a mismatch is annotated in the MD tag, and if that is the case
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
75 counts the identity of the mismatch relative to the reference sequence. The
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
76 output is a PDF document with the calculated frequency for each mismatch that
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
77 occured relative to the total number of valid reads and a table with the
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
78 corresponding values. Read length can be limited to a specific read length, and
2974c382105c planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/mismatch_frequencies commit 10a7e3877c2568d9c23de53fc97dc1c902ff0524-dirty
mvdbeek
parents: 1
diff changeset
79 5 prime and 3 prime-most nucleotides of a read can be ignored.
0
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
80
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
81 ----
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
82
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
83 .. class:: warningmark
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
84
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
85 ***Warning***
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
86
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
87 This tool skips all read that have insertions and has been tested only with bowtie and bowtie2
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
88 generated alignment files.
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
89
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
90 Written by Marius van den Beek, m.vandenbeek at gmail . com
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
91 </help>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
92 <citations>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
93 </citations>
77de5fc623f9 planemo upload for repository https://bitbucket.org/drosofff/gedtools/
mvdbeek
parents:
diff changeset
94 </tool>