annotate snp_caller_caller.xml @ 2:36b4be01cce4 draft default tip

planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit b36048cd608ede0ec6f6559648525c9350caae34-dirty
author wolma
date Sat, 11 Nov 2017 16:39:44 -0500
parents 85576338fbcf
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
1 <tool id="mimodd_varcall" name="MiModD Variant Calling"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
2 version="@MIMODD_WRAPPER_VERSION@">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
3 <description>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
4 generates a BCF file of position-specific variant likelihoods and coverage information based on a reference sequence and reads aligned against it
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
5 </description>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
6 <macros>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
7 <import>macros.xml</import>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
8 <macro name="test_mentions_samples">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
9 <assert_stdout>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
10 <has_text_matching expression="000.+N2" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
11 <has_text_matching expression="266-1.+ot266" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
12 </assert_stdout>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
13 </macro>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
14 </macros>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
15 <expand macro="requirements" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
16 <expand macro="stdio" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
17 <expand macro="version_command" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
18 <command><![CDATA[
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
19 mimodd varcall
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
20 #if str($reference.source) == "cached":
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
21 '$reference.genome.fields.path'
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
22 #else:
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
23 '$reference.genome'
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
24 #end if
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
25 #for $input_file in $list_input
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
26 '$input_file'
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
27 #end for
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
28 --index-files
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
29 #for $input_file in $list_input
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
30 '${input_file.metadata.bam_index}'
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
31 #end for
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
32 --ofile '$ofile'
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
33 $group_by_id
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
34 $adv_settings.md5_check
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
35 --max-depth $adv_settings.max_depth
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
36 --verbose
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
37 --quiet
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
38 ]]></command>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
39
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
40 <inputs>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
41 <conditional name="reference">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
42 <param name="source" type="select"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
43 label="Will you select a reference genome from your history or use a built-in genome?">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
44 <option value="cached">Use a built-in genome</option>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
45 <option value="history">Use a genome from my history</option>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
46 </param>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
47 <when value="cached">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
48 <param name="genome" type="select"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
49 label="reference genome"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
50 help="The fasta reference genome that variants should be called against.">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
51 <options from_data_table="all_fasta" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
52 </param>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
53 </when>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
54 <when value="history">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
55 <param name="genome" type="data" format="fasta"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
56 label="reference genome"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
57 help="The fasta reference genome that variants should be called against."/>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
58 </when>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
59 </conditional>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
60 <param name="list_input" type="data" multiple="true" format="bam"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
61 label="Aligned reads input dataset(s)"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
62 help="Select at least one dataset to call variants on. If you select several datasets or a dataset collection, this tool will perform joint variant calling on all of them and produce a single, possibly multisample, output dataset." />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
63 <param name="group_by_id" type="boolean" truevalue="-i" falsevalue="" checked="false"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
64 label="group reads based on read group id only"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
65 help="If selected, this option ensures that only the read group id (but not the sample name) is considered in grouping reads in the input file(s). If turned off, read groups with identical sample names are automatically pooled and analyzed together even if they come from different NGS runs." />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
66 <section name="adv_settings" title="More options" expanded="False">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
67 <param name="md5_check" type="boolean" truevalue="" falsevalue="-x" checked="true"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
68 label="md5 sum verification of contigs/chromosomes"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
69 help="leave turned on to avoid accidental variant calling against a wrong reference genome version (see the tool help below)." />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
70 <param name="max_depth" type="integer" value="250" min="0"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
71 label="average sample depth cap limit (default: 250)"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
72 help="only relevant for very large sample numbers and/or very high sample coverage; increase to use more of the data, decrease to save memory"/>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
73 </section>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
74 </inputs>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
75
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
76 <outputs>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
77 <data name="ofile" format="bcf"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
78 label="Variant Calls from MiModd Variant Calling on ${on_string}">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
79 <actions>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
80 <conditional name="reference.source">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
81 <when value="cached">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
82 <action type="metadata" name="dbkey">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
83 <option type="from_data_table" name="all_fasta" column="1" offset="0">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
84 <filter type="param_value" ref="reference.genome" column="0" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
85 </option>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
86 </action>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
87 </when>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
88 </conditional>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
89 </actions>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
90 </data>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
91 </outputs>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
92
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
93 <tests>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
94 <test>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
95 <conditional name="reference">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
96 <param name="source" value="history" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
97 <param name="genome" value="a.fa" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
98 </conditional>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
99 <param name="list_input" value="a.bam" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
100 <expand macro="test_mentions_samples" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
101 </test>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
102 <test>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
103 <conditional name="reference">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
104 <param name="source" value="history" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
105 <param name="genome" value="a.fa" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
106 </conditional>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
107 <param name="list_input" value="a_part1.bam,a_part2.bam" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
108 <expand macro="test_mentions_samples" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
109 </test>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
110 <test>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
111 <conditional name="reference">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
112 <param name="source" value="history" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
113 <param name="genome" value="a.fa" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
114 </conditional>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
115 <param name="list_input" value="a.bam" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
116 <param name="group_by_id" value="true" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
117 <section name="adv_settings">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
118 <param name="md5_check" value="false" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
119 <param name="max_depth" value="1000" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
120 </section>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
121 <assert_command>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
122 <has_text text="-i" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
123 <has_text text="-x" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
124 <has_text text="--max-depth 1000" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
125 </assert_command>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
126 </test>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
127 </tests>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
128 <help><![CDATA[
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
129 .. class:: infomark
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
130
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
131 **What it does**
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
132
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
133 The tool transforms the read-centered information in the aligned reads input
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
134 datasets into position-centered information including variant call statistics
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
135 (using samtools mpileup and bcftools internally).
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
136
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
137 **It produces a BCF file that serves as the basis for all further variant
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
138 analyses with MiModD**.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
139
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
140 -----
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
141
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
142 **Notes on Advanced Settings:**
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
143
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
144 **MD5 checksums**
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
145
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
146 By default, the tool will check whether the input BAM dataset(s) provide(s) MD5
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
147 checksums for the reference genome contig/chromosome sequences used during read
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
148 alignment (e.g., the *MiModD Read Alignment* tool stores these in the BAM file
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
149 header). If it finds MD5 sums for all sequences, it will compare them to the
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
150 checksums of the reference genome sequences used in the current tool run and
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
151 abort with an error message if there is a discrepancy between them. If it finds
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
152 contigs/chromosomes with matching checksum, but different names in the aligned
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
153 reads dataset(s) and the reference genome dataset, it will use the name from
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
154 the reference genome in its output.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
155
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
156 This behavior has two benefits:
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
157
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
158 1) It protects from accidental variant calling against a wrong reference genome
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
159 (*i.e.*, a different one than that used during the alignment step), which would
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
160 result in wrong calls. This is the primary reason why we recommend to leave the
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
161 check activated.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
162
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
163 2) It provides an opportunity to change sequence names between aligned reads
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
164 files and variant call files by providing a reference genome file with altered
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
165 sequence names (but identical sequence data).
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
166
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
167 Since there may be rare cases where you *really* want to align against a
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
168 reference genome with different checksums (e.g., you may have edited the
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
169 reference sequence based on the alignment results), the check can be turned
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
170 off, but only do this if you know *exactly* why.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
171
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
172
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
173 **Average sample depth cap limit**
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
174
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
175 For each of a total of ``M`` BAM input datasets, the tool will only pile up a
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
176 maximum number of reads ``N`` per position to avoid excessive memory usage with
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
177 very large numbers of samples sequenced at high coverage.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
178 N will be calculated as the maximum of ``8000/M`` and ``DEPTH*S``, where ``S``
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
179 is the maximum number of samples found in a single input dataset and ``DEPTH``
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
180 is the *average sample depth cap limit* specified in the tool form.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
181
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
182 This parameter, thus sets the average depth of the pile-up per sample that is
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
183 guaranteed to be used even when there is a very large number of samples. As can
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
184 be seen from the formula above, however, it will rarely become relevant for any
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
185 regular-size analysis.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
186
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
187
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
188 @HELP_FOOTER@
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
189 ]]></help>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
190 <expand macro="citations" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
191 </tool>