annotate bamqc.xml @ 5:f6ffb9aa409e draft default tip

Adding some more info
author Joachim Jacob <joachim.jacob@gmail.com>
date Wed, 20 Mar 2013 09:41:43 +0100
parents 3d690162d629
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
1
4
3d690162d629 Added more details for the required dependencies.
Joachim Jacob <joachim.jacob@gmail.com>
parents: 3
diff changeset
2 <tool id="qualimap_bamqc" name="Analyse SAM/BAM with bamqc" version="1.0.1">
2
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
3 <!-- Additional info: wrapper compatible with versions ..... -->
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
4 <description>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
5 to asses mapping quality metrics.
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
6 </description>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
7
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
8 <version_command>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
9 qualimap --version
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
10 </version_command>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
11
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
12 <requirements>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
13 <requirement type="package">qualimap</requirement>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
14 </requirements>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
15
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
16 <command interpreter="perl">
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
17 ## it is recommended that you write a wrapper for your tool
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
18 ## and pass all parameters to that tool, which parses them.
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
19 bamqc_wrapper.pl $configfile
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
20 </command>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
21
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
22 <inputs>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
23 <param format="sam,bam" name="bam" type="data" label="Alignments in the BAM or SAM format" help="The set of aligned reads." />
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
24 <param type="boolean" name="c" checked="TRUE" truevalue="-c" falsevalue="" label="paint chromosome limits inside charts" />
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
25 <conditional name="customgtf">
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
26 <param name="upload" type="select" label="BETA! Analyze the alignment data for the regions of interest you provide">
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
27 <option value="yes">Yes</option>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
28 <option value="no" selected="true">No</option>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
29 </param>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
30 <when value="yes">
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
31 <param name="gff" type="data" format="bed,gtf,gff3" label="Choose your feature annotation file" help="Provide your BED, GTF or GFF file"/>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
32 <param name="os" type="boolean" checked="FALSE" truevalue="-os" falsevalue="" label="compute also regions outside stats" help="If checked, the information about the reads that are mapped outside of the regions of interest will be also computed and shown in a separate section" />
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
33 <param type="select" name="p" label="The sequencing protocol strand specificity" help="Can be non-strand-specific, forward-stranded orreverse-stranded. This information is required to calculate the number of correct strand reads.">
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
34 <option value="NON-STRAND-SPECIFIC">Non-strand-specific</option>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
35 <option value="STRAND-SPECIFIC-FORWARD">Strand-specific forward</option>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
36 <option value="STRAND-SPECIFIC-REVERSE">Strand-specific reverse</option>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
37 </param>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
38 </when>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
39 <when value="no"/>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
40 </conditional>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
41 <param name="hm" type="text" size="3" value="3" label="minimum size for a homopolymer to be considered in indel analysis" help="Only homopolymers of this size or larger will be considered when estimating homopolymer indels count"/>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
42 <param name="nr" type="text" size="6" value="1000" label="number of reads in the chunk" help="In order to reduce the load of I/O, reads are analyzed in chunks. Each chunk contains the selected number of reads which will be loaded into memory and analyzed by a single thread. Smaller numbers may result in lower performance, but also the memory consumption will be reduced. The default value is 1000 reads"/>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
43 </inputs>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
44
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
45 <outputs>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
46 <data format="html" name="bamqc_result" label="${tool.name} on ${on_string}">
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
47 <!-- <data format="html" name="bamqc_result" label="${tool.name} on ${on_string}" from_work_dir="bamqc_output/qualimapReport.html"> -->
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
48 </data>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
49 </outputs>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
50
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
51 <configfiles>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
52 <!-- this config file collects all parameter settings -->
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
53 <configfile name="configfile">
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
54 ## first we pass some galaxy environment variables
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
55 galtemp==${__new_file_path__}
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
56
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
57 bamqc_result==$bamqc_result
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
58 outputdir==$bamqc_result.files_path
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
59 bam==$bam
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
60 c==$c
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
61 hm==$hm
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
62 nr==$nr
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
63 #if $customgtf.upload=="yes"
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
64 gff==$customgtf.gff
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
65 os==$customgtf.os
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
66 p==$customgtf.p
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
67 #end if
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
68 </configfile>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
69 </configfiles>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
70
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
71 <tests>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
72 </tests>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
73
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
74 <help>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
75 **Tool Overview**
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
76
3
9537dd9dd18b Uploaded
joachim-jacob
parents: 2
diff changeset
77 Bamqc_ allows for simply but throroughly checking of the quality of mapping.
2
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
78
3
9537dd9dd18b Uploaded
joachim-jacob
parents: 2
diff changeset
79 .. _Bamqc: http://qualimap.bioinfo.cipf.es//
2
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
80
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
81 ------
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
82
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
83 </help>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
84 </tool>
934cd08c77af Uploaded
joachim-jacob
parents:
diff changeset
85