annotate varreport.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_varreport" name="MiModD Report Variants"
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 in a human-friendly format that simplifies data exploration
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 </macros>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
9 <expand macro="requirements" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
10 <expand macro="stdio" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
11 <expand macro="version_command" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
12 <command><![CDATA[
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
13 #if $str($formatting.oformat) == 'html':
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
14 mkdir '$ofile.files_path' &&
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
15 #end if
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
16 mimodd varreport
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
17 '$inputfile' --oformat ${formatting.oformat}
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
18 #if $str($formatting.oformat) == 'html':
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
19 #if $str($formatting.species):
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
20 --species '${formatting.species}'
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
21 #end if
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
22 #if $formatting.link_formatter:
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
23 --link '${formatting.link_formatter}'
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 --ofile '${ofile.files_path}/variant_report.html'
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
26 && echo
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
27 '<html><body><p>MiModD has generated the variant report you requested, but for technical reasons, we have to take you through this little detour to display the report in Galaxy.</p><p>Proceed to <a href="variant_report.html">the variant report</a>.</p></body></html>'
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
28 > '$ofile'
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
29 #else
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
30 --ofile '$ofile'
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
31 #end if
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
32 ]]></command>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
33
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
34 <inputs>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
35 <param name="inputfile" type="data" format="vcf"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
36 label="The VCF input with the variants to be reported" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
37 <conditional name="formatting">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
38 <param name="oformat" type="select"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
39 label="Format to use for the report">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
40 <option value="html">HTML</option>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
41 <option value="text">Tab-separated plain text</option>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
42 </param>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
43 <when value="html">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
44 <param name="species" type="text" label="Species"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
45 help="If you declare the species your input data comes from, variant reports in html format can have hyperlinks to species-specific databases and genome browsers added. If you have used the MiModD Variant Annotation tool to generate the input dataset, the species information will already be recorded in the dataset, but you can overwrite it if you wish." />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
46 <param name="link_formatter" type="data" format="txt" optional="true"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
47 label="Optional file with species-specific hyperlink formatting instructions"
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
48 help="If the tool has no built-in support for your species, i.e., it does not know how to generate hyperlinks for it, you can provide a custom recipe here." />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
49 </when>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
50 <when value="text">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
51 <param name="species" type="hidden" value="" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
52 </when>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
53 </conditional>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
54 </inputs>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
55
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
56 <outputs>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
57 <data name="ofile" format="html">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
58 <change_format>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
59 <when input="formatting.oformat" value="text" format="tabular"/>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
60 </change_format>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
61 </data>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
62 </outputs>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
63
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
64 <tests>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
65 <test>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
66 <param name="inputfile" value="a.vcf" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
67 <conditional name="formatting">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
68 <param name="oformat" value="html" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
69 <param name="species" value="C. elegans" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
70 </conditional>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
71 <output name="ofile" ftype="html">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
72 <extra_files type="file" name="variant_report.html" ftype="html">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
73 <assert_contents>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
74 <has_line_matching expression=".+tools/genome/gbrowse/c_elegans_PRJNA13758.+" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
75 </assert_contents>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
76 </extra_files>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
77 </output>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
78 </test>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
79 <test>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
80 <param name="inputfile" value="a.vcf" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
81 <conditional name="formatting">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
82 <param name="oformat" value="text" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
83 </conditional>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
84 <output name="ofile" ftype="tabular">
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
85 <assert_contents>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
86 <has_n_columns n="11" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
87 <has_line_matching expression="Chromosome&#009;Position&#009;Affected Gene&#009;Transcript&#009;Effects&#009;genotype N2&#009;.+genotype ot266&#009;.+" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
88 <has_line_matching expression="chrI&#009;.+" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
89 </assert_contents>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
90 </output>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
91 </test>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
92 </tests>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
93
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
94 <help><![CDATA[
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
95 .. class:: infomark
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
96
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
97 **What it does**
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
98
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
99 The tool turns a variant list in VCF format into a more readable summary table
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
100 listing variant sites and effects.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
101
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
102
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
103 **Html output enriched with species-specific hyperlinks**
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
104
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
105 If you select html as the output format, the tool can insert species- and
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
106 variant-specific hyperlinks to public genome browsers and databases into the
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
107 report. This is a useful feature to explore medium-size lists of variants, but
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
108 requires that the tool knows:
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
109
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
110 1) the species that you are analyzing data for
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
111
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
112 The tool can autodetect the species if the input dataset has been generated
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
113 with the *MiModD Variant Annotation* tool. Alternatively, you can declare
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
114 the species you are working with explicitly.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
115
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
116 2) how to generate hyperlinks for this species
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
117
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
118 The tool has built-in support for a number of standard model organisms.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
119 If your organism is not in that list or if you find that the default
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
120 hyperlinks for a supported species are outdated, you can provide your own
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
121 recipe to generate correct hyperlinks through a `custom hyperlink template
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
122 file`_.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
123
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
124 **TIP:**
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
125 MiModD's built-in hyperlink formatting tables are actively maintained and
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
126 extended with every new version! If you find the tool produces outdated
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
127 hyperlinks for any supported species or if you would like to see additional
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
128 species supported, do not hesitate to `tell us about it`_.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
129 If you have a custom hyperlink template file that is working for you, that
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
130 is even better. We may use it as a starting point for a built-in recipe and,
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
131 while we are working on that and with your permission, we can post it on the
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
132 package home page for other users who may need it.
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
133
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
134 .. _custom hyperlink template file: http://mimodd.readthedocs.io/en/@MIMODD_REAL_VERSION@/recipes.html#hyperlink-template-file
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
135 .. _tell us about it: mailto:mimodd@googlegroups.com
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 @HELP_FOOTER@
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
138 ]]></help>
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
139 <expand macro="citations" />
85576338fbcf planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit c4b4112ac89be8b7e43427220473269e52cb9797
wolma
parents:
diff changeset
140 </tool>