annotate mismatch_frequencies.xml @ 7:270681625775

Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
author mvdbeek
date Wed, 28 Jan 2015 13:12:56 +0100
parents a7bf987b8cc4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
1 <tool id="mismatch_frequencies" name="Mismatch Frequencies" version="0.0.5" hidden="false" >
6
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
2 <description>Analyze mismatch frequencies in BAM/SAM alignments</description>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
3 <requirements>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
4 <requirement type="package" version="0.7.7">pysam</requirement>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
5 <requirement type="package" version="0.14">pandas</requirement>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
6 <requirement type="package" version="1.4">matplotlib</requirement>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
7 </requirements>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
8 <command interpreter="python">mismatch_frequencies.py --input
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
9 #for i in $rep
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
10 "$i.input_file"
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
11 #end for
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
12 --name
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
13 #for i in $rep
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
14 "$i.input_file.name"
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
15 #end for
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
16 --output_pdf $output_pdf --output_tab $output_tab --min $min_length --max $max_length
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
17 --n_mm $number_of_mismatches
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
18 --five_p $five_p
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
19 --three_p $three_p
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
20 </command>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
21 <inputs>
7
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
22 <repeat name="rep" title="alignment files" min="1">
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
23 <param name="input_file" type="data" format="bam,sam" label="Alignment file" help="The input alignment file(s) for which you want to calculate mismatch frequencies."/>
6
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
24 </repeat>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
25 <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"/>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
26 <param name="min_length" label="Minumum read length to analyse" type="integer" value="21"/>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
27 <param name="max_length" label="Maximum read length to analyse" type="integer" value="21"/>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
28 <param name="five_p" label="Ignore mismatches in the first N nucleotides of a read" type="integer" value="0"/>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
29 <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"/>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
30 </inputs>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
31 <outputs>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
32 <data format="tabular" name="output_tab" />
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
33 <data format="pdf" name="output_pdf" />
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
34 </outputs>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
35 <tests>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
36 <test>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
37 <param name="rep_0|input_file" value="3mismatches_ago2ip_s2.bam" ftype="bam" />
7
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
38 <param name="rep_1|input_file" value="3mismatches_ago2ip_ovary.bam" ftype="bam" />
6
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
39 <param name="number_of_mismatches" value="1" />
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
40 <param name="min_length" value="21" />
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
41 <param name="max_length" value="21" />
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
42 <output name="tabular" file="mismatch.tab" ftype="tabular"/>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
43 </test>
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
44 </tests>
7
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
45 <help>
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
46
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
47 .. class:: infomark
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
48
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
49
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
50 ***What it does***
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
51
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
52 This tool reconstitues for each aligned read of an alignment file in SAM/BAM format whether
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
53 a mismatch is annotated in the MD tag, and if that is the case counts the identity of the
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
54 mismatch relative to the reference sequence. The output is a PDF document with the calculated
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
55 frequency for each mismatch that occured relative to the total number of valid reads and a table
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
56 with the corresponding values. Read length can be limited to a specific read length, and 5 prime and
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
57 3 prime-most nucleotides of a read can be ignored.
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
58
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
59 ----
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
60
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
61 .. class:: warningmark
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
62
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
63 ***Warning***
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
64
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
65 This tool skips all read that have insertions and has been tested only with bowtie and bowtie2
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
66 generated alignment files.
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
67
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
68 Written by Marius van den Beek, m.vandenbeek at gmail . com
270681625775 Add help text and fix for skipping the beginning/end of reads aligned in reverse orientation.
mvdbeek
parents: 6
diff changeset
69 </help>
6
a7bf987b8cc4 Uploaded
mvdbeek
parents:
diff changeset
70 </tool>