annotate abjbrowse2.xml @ 14:7c2e28e144f3 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/jbrowse2 commit 5d84967148d45684d585d4e12b210dc5e12e4776

<tool id="jbrowse2" name="JBrowse2" version="@TOOL_VERSION@+@WRAPPER_VERSION@">
    <description>genome browser</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <edam_topics>
        <edam_topic>topic_3307</edam_topic>
        <edam_topic>topic_0092</edam_topic>
    </edam_topics>
    <edam_operations>
        <edam_operation>operation_0573</edam_operation>
        <edam_operation>operation_0564</edam_operation>
    </edam_operations>
    <xrefs>
        <xref type="bio.tools">jbrowse</xref>
    </xrefs>
    <expand macro="requirements"/>
    <version_command>python '${__tool_directory__}/jbrowse2.py' --version</version_command>
    <command detect_errors="aggressive"><![CDATA[
mkdir -p $output.files_path &&
#if $action.action_select != "create":
    cp -R $action.update_jbrowse.extra_files_path/data $output.files_path/data &&
#end if

## Copy the XML file into the directory, mostly for debugging
## but nice if users want to reproduce locally
cp $trackxml $output.files_path/galaxy.xml &&

export JBROWSE2_SOURCE_DIR=\$(dirname \$(which jbrowse))/../opt/jbrowse2  &&

## Once that's done, we run the python script to handle the real work
python '$__tool_directory__/jbrowse2.py'

--jbrowse \${JBROWSE2_SOURCE_DIR}

--outdir $output.files_path
$trackxml &&

cp $output.files_path/index.html $output;

## Ugly testing hack since I cannot get <extra_files> to test the files I want to test. Hmph.
#if str($uglyTestingHack) == "enabled":
    cp $trackxml $output
#end if
  ]]></command>
  <configfiles>
      <configfile name="trackxml"><![CDATA[<?xml version="1.0"?>
<root>
    <metadata>
        <genomes>
            #if str($reference_genome.genome_type_select) == "indexed":
              <genome path="${reference_genome.genomes.fields.path}" label="${reference_genome.genomes.fields.name}">
                  <metadata />
              </genome>s
            #else
              <genome path="$reference_genome.genome" label="${reference_genome.genome.element_identifier}">
                <metadata>
                  <dataset id="${__app__.security.encode_id($reference_genome.genome.id)}" hid="${reference_genome.genome.hid}"
                      size="${reference_genome.genome.get_size(nice_size=True)}"
                      edam_format="${reference_genome.genome.datatype.edam_format}"
                      file_ext="${reference_genome.genome.ext}" />
                  <history id="${__app__.security.encode_id($reference_genome.genome.history_id)}"
                      #if $reference_genome.genome.history.user:
                      user_email="${reference_genome.genome.history.user.email}"
                      user_id="${reference_genome.genome.history.user_id}"
                      display_name="${reference_genome.genome.history.get_display_name()}"/>
                      #else
                      user_email="anonymous"
                      user_id="-1"
                      display_name="Unnamed History"/>
                      #end if
                  <metadata
                      #for (key, value) in $reference_genome.genome.get_metadata().items():
                      #if "_types" not in $key:
                        #if isinstance($value, list):
                          #set value_str = "[%s]" % ','.join([str(val) for val in value])
                          ${key}="$value_str"
                        #else
                          ${key}="${value}"
                        #end if
                      #end if
                      #end for
                      />
                  <tool
                      tool_id="${reference_genome.genome.creating_job.tool_id}"
                      tool_version="${reference_genome.genome.creating_job.tool_version}"
                      />
                </metadata>
              </genome>
            #end if
        </genomes>
        <general>
            <defaultLocation>${jbgen.defaultLocation}</defaultLocation>
            <analytics>${jbgen.enableAnalytics}</analytics>
            <primary_color>${jbgen.primary_color}</primary_color>
            <secondary_color>${jbgen.secondary_color}</secondary_color>
            <tertiary_color>${jbgen.tertiary_color}</tertiary_color>
            <quaternary_color>${jbgen.quaternary_color}</quaternary_color>
            <font_size>${jbgen.font_size}</font_size>
            <session_name>${jbgen.session_name}</session_name>
        </general>
        <galaxyUrl>${__app__.config.galaxy_infrastructure_url}</galaxyUrl>
    </metadata>
    <tracks>
        #for $tg in $track_groups:
        #for $track in $tg.data_tracks:
        <track cat="${tg.category}" format="${track.data_format.data_format_select}" visibility="${track.data_format.track_visibility}">
            #if $track.data_format.data_format_select != "sparql":
            <files>
              #for $dataset in $track.data_format.annotation:
              <trackFile path="${dataset}" ext="${dataset.ext}" label="${dataset.element_identifier}">
                <metadata>
                  <dataset id="${__app__.security.encode_id($dataset.id)}" hid="${dataset.hid}"
                      size="${dataset.get_size(nice_size=True)}"
                      edam_format="${dataset.datatype.edam_format}"
                      file_ext="${dataset.ext}" />
                  <history id="${__app__.security.encode_id($dataset.history_id)}"
                      #if $dataset.history.user:
                      user_email="${dataset.history.user.email}"
                      user_id="${dataset.history.user_id}"
                      display_name="${dataset.history.get_display_name()}"/>
                      #else
                      user_email="anonymous"
                      user_id="-1"
                      display_name="Unnamed History"/>
                      #end if
                  <metadata
                    #for (key, value) in $dataset.get_metadata().items():
                    #if "_types" not in $key and $value is not None and len(str($value)) < 5000:
                      #if isinstance($value, list):
                        #set value_str = "[%s]" % ','.join([str(val) for val in value])
                        ${key}="$value_str"
                      #else
                        ${key}="${value}"
                      #end if
                    #end if
                    #end for
                      />
                  <tool
                      tool_id="${dataset.creating_job.tool_id}"
                      tool_version="${dataset.creating_job.tool_version}"
                      />
                </metadata>
              </trackFile>
              #end for
            </files>
            #end if

            <options>
                <style>
                    <display>${track.data_format.jbstyle.track_style.display}</display>
                    ## TODO change this to a for loop?
                    #if 'show_labels' in $track.data_format.jbstyle.track_style
                      <trackShowLabels type="boolean">${track.data_format.jbstyle.track_style.show_labels}</trackShowLabels>
                    #end if
                    #if 'show_descriptions' in $track.data_format.jbstyle.track_style
                      <trackShowDescriptions type="boolean">${track.data_format.jbstyle.track_style.show_descriptions}</trackShowDescriptions>
                    #end if
                    #if 'display_mode' in $track.data_format.jbstyle.track_style
                      <trackDisplayMode>${track.data_format.jbstyle.track_style.display_mode}</trackDisplayMode>
                    #end if
                    #if 'max_height' in $track.data_format.jbstyle.track_style
                      <trackMaxHeight type="integer">${track.data_format.jbstyle.track_style.max_height}</trackMaxHeight>
                    #end if
                    #if 'autoscale' in $track.data_format.jbstyle.track_style
                      <autoscale>${track.data_format.jbstyle.track_style.autoscale}</autoscale>
                    #end if
                    #if 'resolution' in $track.data_format.jbstyle.track_style
                      <resolution type="integer">${track.data_format.jbstyle.track_style.resolution}</resolution>
                    #end if
                    #if 'summaryScoreMode' in $track.data_format.jbstyle.track_style
                      <summaryScoreMode>${track.data_format.jbstyle.track_style.summaryScoreMode}</summaryScoreMode>
                    #end if
                    #if 'scaleType' in $track.data_format.jbstyle.track_style
                      <scaleType>${track.data_format.jbstyle.track_style.scaleType}</scaleType>
                    #end if
                    #if 'filled' in $track.data_format.jbstyle.track_style
                      <filled type="boolean">${track.data_format.jbstyle.track_style.filled}</filled>
                    #end if
                    #if 'displayCrossHatches' in $track.data_format.jbstyle.track_style
                      <displayCrossHatches type="boolean">${track.data_format.jbstyle.track_style.displayCrossHatches}</displayCrossHatches>
                    #end if
                    #if 'minScore' in $track.data_format.jbstyle.track_style and $track.data_format.jbstyle.track_style.minScore
                      <minScore type="integer">${track.data_format.jbstyle.track_style.minScore}</minScore>
                    #end if
                    #if 'maxScore' in $track.data_format.jbstyle.track_style and $track.data_format.jbstyle.track_style.maxScore
                      <maxScore type="integer">${track.data_format.jbstyle.track_style.maxScore}</maxScore>
                    #end if
                    ## TODO other coloring/etc options in each renderer (e.g https://github.com/GMOD/jbrowse-components/blob/main/plugins/svg/src/SvgFeatureRenderer/configSchema.ts)
                </style>
                <style_labels>
                    ## TODO other label options: https://github.com/GMOD/jbrowse-components/blob/main/plugins/svg/src/SvgFeatureRenderer/configSchema.ts
                    #if 'label' in $track.data_format.jbstyle.track_style
                    <name>${track.data_format.jbstyle.track_style.label}</name>
                    #end if
                    #if 'description' in $track.data_format.jbstyle.track_style
                    <description>${track.data_format.jbstyle.track_style.description}</description>
                    #end if
                </style_labels>
              #if str($track.data_format.data_format_select) == "gene_calls" or str($track.data_format.data_format_select) == "blast" or str($track.data_format.data_format_select) == "sparql":
                <scaling>
                  #if str($track.data_format.jbcolor_scale.color_score.color_score_select) == "none":
                        <method>ignore</method>
                        <scheme>
                          #if str($track.data_format.jbcolor_scale.color_score.color.color_select) == "automatic":
                            <color>__auto__</color>
                          #else
                            <color>${track.data_format.jbcolor_scale.color_score.color.style_color}</color>
                          #end if
                        </scheme>
                  #else
                        <method>score</method>
                        <algo>${track.data_format.jbcolor_scale.color_score.score_scaling}</algo>
                        <scales>
                            <type>${track.data_format.jbcolor_scale.color_score.score_scales.scale_select}</type>

                          #if str($track.data_format.jbcolor_scale.color_score.score_scales.scale_select) == "manual":
                            <min>${track.data_format.jbcolor_scale.color_score.score_scales.minimum}</min>
                            <max>${track.data_format.jbcolor_scale.color_score.score_scales.maximum}</max>
                          #end if
                        </scales>
                        <scheme>
                            <type>${track.data_format.jbcolor_scale.color_score.color_scheme.score_scheme}</type>
                        ## auto_color
                        #if str($track.data_format.jbcolor_scale.color_score.color_scheme.score_scheme) == "opacity":
                          #if str($track.data_format.jbcolor_scale.color_score.color_scheme.color.color_select) == "automatic":
                            <color>__auto__</color>
                          #else
                            <color>${track.data_format.jbcolor_scale.color_score.color_scheme.color.style_color}</color>
                          #end if
                        #end if
                        </scheme>
                  #end if
                </scaling>
                <menus>
                  #for $menu_item in $track.data_format.jbmenu.track_menu:
                  <menu>
                    <action>${menu_item.menu_action}</action>
                    #if str($menu_item.menu_label) != "":
                      <label>${menu_item.menu_label}</label>
                    #end if
                    #if str($menu_item.menu_title) != "":
                      <title>${menu_item.menu_title}</title>
                    #end if
                    #if str($menu_item.menu_url) != "":
                      <url>${menu_item.menu_url.replace("&", "&amp;").replace("\"", "&quot;")}</url>
                    #end if
                    #if str($menu_item.menu_icon) != "":
                      <iconClass>${menu_item.menu_icon}</iconClass>
                    #end if
                  </menu>
                  #end for
                </menus>
            #end if

            #if str($track.data_format.data_format_select) == "wiggle":
                <wiggle>
                    <type>${track.data_format.xyplot}</type>
                    <variance_band>${track.data_format.var_band}</variance_band>
                  #if str($track.data_format.scaling.scale_select) == "auto_local":
                    <autoscale>local</autoscale>
                  #else if str($track.data_format.scaling.scale_select) == "auto_global":
                    <autoscale>global</autoscale>
                  #else:
                    <min>${track.data_format.scaling.minimum}</min>
                    <max>${track.data_format.scaling.maximum}</max>
                  #end if
                  <scale>${track.data_format.scale_select2}</scale>

                  ## Wiggle tracks need special color config
                  #if str($track.data_format.jbcolor.color.color_select) != "automatic":
                    <color_pos>${track.data_format.jbcolor.color.style_pos_color}</color_pos>
                    <color_neg>${track.data_format.jbcolor.color.style_neg_color}</color_neg>
                  #else:
                    <color_pos>__auto__</color_pos>
                    <color_neg>__auto__</color_neg>
                  #end if

                  ## Bicolor pivot config
                  #if str($track.data_format.jbcolor.bicolor_pivot.bicolor_pivot_select) == "zero":
                    <bicolor_pivot>zero</bicolor_pivot>
                  #else if str($track.data_format.jbcolor.bicolor_pivot.bicolor_pivot_select) == "mean":
                    <bicolor_pivot>mean</bicolor_pivot>
                  #else:
                    <bicolor_pivot>${track.data_format.jbcolor.bicolor_pivot.pivot_point}</bicolor_pivot>
                  #end if
                </wiggle>
            #else if str($track.data_format.data_format_select) == "pileup":
                <pileup>
                    <bam_indices>
                        #for $dataset in $track.data_format.annotation:
                        <bam_index>${dataset.metadata.bam_index}</bam_index>
                        #end for
                    </bam_indices>
                </pileup>
            #else if str($track.data_format.data_format_select) == "cram":
                <cram>
                    <cram_indices>
                        #for $dataset in $track.data_format.annotation:
                        <cram_index>${dataset.metadata.cram_index}</cram_index>
                        #end for
                    </cram_indices>
                </cram>
            #else if str($track.data_format.data_format_select) == "blast":
                <blast>
                  #if str($track.data_format.blast_parent) != "":
                    <parent>${track.data_format.blast_parent}</parent>
                  #end if
                    <protein>${track.data_format.is_protein}</protein>
                    <min_gap>${track.data_format.min_gap}</min_gap>
                    <index>${track.data_format.index}</index>
                </blast>
            #else if str($track.data_format.data_format_select) == "gene_calls":
                <gff>
                  #if $track.data_format.match_part.match_part_select:
                    <match>${track.data_format.match_part.name}</match>
                  #end if
                    <index>${track.data_format.index}</index>
                </gff>
            #else if str($track.data_format.data_format_select) == "synteny":
                <synteny>
                    <genome>${track.data_format.synteny_genome}</genome>
                    <genome_label>${track.data_format.synteny_genome.element_identifier}</genome_label>
                </synteny>
            #else if str($track.data_format.data_format_select) == "hic":
                <hic>
                </hic>
            #else if str($track.data_format.data_format_select) == "sparql":
                <label>${track.data_format.label}</label>
                <sparql>
                    <url>${track.data_format.url}</url>
                    <query>${track.data_format.query}</query>
                    <query_refnames>${track.data_format.query_refnames}</query_refnames>
                </sparql>
            #end if
            </options>
        </track>
        #end for
        #end for
    </tracks>
</root>
]]></configfile>
    </configfiles>
    <inputs>
        <conditional name="reference_genome">
            <param help="Built-in references" label="Reference genome to display" name="genome_type_select" type="select">
                <option selected="True" value="indexed">Use a built-in genome</option>
                <option value="history">Use a genome from history</option>
            </param>
            <when value="indexed">
                <param
                help="If your genome of interest is not listed, contact the Galaxy team"
                label="Select a reference genome"
                name="genomes"
                type="select"
                >
                    <options from_data_table="all_fasta">
                        <filter column="2" type="sort_by" />
                        <validator message="No genomes are available for the selected input dataset" type="no_options" />
                    </options>
                </param>
            </when>
            <when value="history">
                <param
                format="fasta"
                label="Select the reference genome"
                name="genome"
                type="data" />
            </when>
        </conditional>
        <!-- TODO auto add GC track when implemented
             https://github.com/GMOD/jbrowse-components/pull/2683
             https://github.com/GMOD/jbrowse-components/pull/3328
        -->

        <!-- TODO genetic code not yet supported in jbrowse2
             https://github.com/GMOD/jbrowse-components/issues/1765
        -->

        <conditional name="action">
            <param type="select" label="JBrowse-in-Galaxy Action" name="action_select">
                <option value="create">New JBrowse Instance</option>
                <option value="update">Update exising JBrowse Instance</option>
            </param>
            <when value="create" />
            <when value="update">
                <param name="update_jbrowse" type="data" format="html" label="Previous JBrowse Instance" />
            </when>
        </conditional>

        <repeat name="track_groups" title="Track Group">
            <param label="Track Category"
                name="category"
                type="text"
                value="Default"
                help="Organise your tracks into Categories for a nicer end-user experience. You can use #date# and it will be replaced with the current date in 'yyyy-mm-dd' format, which is very useful for repeatedly updating a JBrowse instance when member databases / underlying tool versions are updated." optional="False"/>
            <repeat name="data_tracks" title="Annotation Track">
                <conditional name="data_format" label="Track Options">
                    <param type="select" label="Track Type" name="data_format_select">
                        <option value="gene_calls">GFF/GFF3/BED Features</option>
                        <option value="pileup">BAM Pileups</option>
                        <option value="cram">CRAM</option>
                        <option value="blast">Blast XML</option>
                        <option value="wiggle">BigWig XY</option>
                        <option value="vcf">VCF SNPs</option>
                        <option value="synteny">Synteny</option>
                        <option value="hic">HiC</option>
                        <option value="sparql">SPARQL</option>
                    </param>
                    <when value="blast">
                        <expand macro="input_conditional" label="BlastXML Track Data" format="blastxml" />

                        <param label="Features used in Blast Search"
                            help="in GFF3. This is used  so we know where to map features. E.g. where results of which CDS Protein32 match up to. The query IDs in your blast results should MATCH some feature IDs in your GFF3 file. This is an optional field and is most useful if using JBrowse to display protein blast results on a DNA genome. blastn results don't need this, blastp results on a protein sequence don't need this."
                            format="gff3"
                            name="blast_parent"
                            optional="true"
                            type="data"/>

                        <param label="Minimum Gap Size"
                            help="before a new match_part feature is created"
                            name="min_gap"
                            type="integer"
                            value="10"
                            min="2" />
                        <param label="Is this a protein blast search?"
                            type="boolean"
                            name="is_protein"
                            truevalue="true"
                            falsevalue="false" />

                        <param label="Index this track" name="index" type="boolean" checked="false" truevalue="true" falsevalue="false" />

                        <expand macro="track_styling_feature"
                                classname="feature"
                                label="description"
                                description="Hit_titles"
                                height="600px"/>
                        <expand macro="color_selection"
                                token_scaling_lin_select="false"
                                token_scaling_log_select="true" />
                        <expand macro="track_menu" />
                        <expand macro="track_visibility" />
                    </when>
                    <when value="vcf">
                        <expand macro="input_conditional" label="SNP Track Data" format="vcf,vcf_bgzip" />
                        <expand macro="track_styling_vcf"/>
                        <expand macro="track_visibility" />
                    </when>
                    <when value="gene_calls">
                        <expand macro="input_conditional" label="GFF/GFF3/BED Track Data" format="gff,gff3,bed" />
                        <conditional name="match_part" label="match/match_part data">
                            <param label="This is match/match_part data"
                                type="boolean"
                                name="match_part_select"
                                truevalue="true"
                                falsevalue="false" />
                            <when value="true">
                                <param label="Match Part Feature Type"
                                    name="name"
                                    type="text"
                                    value="match"
                                    help="Match_parts have several options for the parent feature type, such as cDNA_match, match, translated_nucleotide_match, etc. Please select the appropriate one here. You can leave empty to try autodetection (only works with CanvasFeatures track type)."
                                    optional="True"/>
                            </when>
                            <when value="false" />
                        </conditional>

                        <param label="Index this track" name="index" type="boolean" checked="false" truevalue="true" falsevalue="false" />

                        <expand macro="track_styling_feature"
                                classname="feature"
                                label="product,name,id"
                                description="note,description"
                                height="10px"/>
                        <expand macro="color_selection" />
                        <expand macro="track_menu" />
                        <expand macro="track_visibility" />
                    </when>
                    <when value="pileup">
                        <expand macro="input_conditional" label="BAM Track Data" format="bam" />
                        <expand macro="track_styling_xam"/>
                        <expand macro="track_visibility" />
                    </when>
                    <when value="cram">
                        <expand macro="input_conditional" label="CRAM Track Data" format="cram" />
                        <expand macro="track_styling_xam"/>
                        <expand macro="track_visibility" />
                    </when>
                    <when value="wiggle">
                        <expand macro="input_conditional" label="BigWig Track Data" format="bigwig" />

                        <param label="Use XYPlot"
                            help="instead of continuous colored band"
                            type="boolean"
                            name="xyplot"
                            truevalue="JBrowse/View/Track/Wiggle/XYPlot"
                            falsevalue="JBrowse/View/Track/Wiggle/Density" />
                        <param label="Show variance band"
                            help="Only for XYPlots"
                            type="boolean"
                            name="var_band"
                            truevalue="true"
                            falsevalue="false" />

                        <conditional name="scaling" label="Scaling">
                            <param type="select" label="Track Scaling" name="scale_select">
                                <option value="auto_local" selected="true">Autoscale (local)</option>
                                <option value="auto_global">Autoscale (global)</option>
                                <option value="fixed">Specify Min/Max</option>
                            </param>
                            <when value="auto_local"></when>
                            <when value="auto_global"></when>
                            <when value="fixed">
                                <param label="Track minimum" name="minimum"
                                    type="integer" value="0" />
                                <param label="Track maximum" name="maximum"
                                    type="integer" value="100" />
                            </when>
                        </conditional>
                        <param type="select" label="Visual Scaling" name="scale_select2">
                            <option value="linear" selected="true">Linear</option>
                            <option value="log">Logarithmic (Dynamically Calculated)</option>
                        </param>

                        <expand macro="color_selection_minmax" />

                        <expand macro="track_styling_bigwig"/>
                        <expand macro="track_visibility" />
                    </when>

                    <when value="synteny">
                        <param label="Other genome sequence"
                            format="fasta"
                            name="synteny_genome"
                            type="data" />
                        <!-- TODO add .out (MashMap) .chain (UCSC), .delta (mummer) and .anchors (mcscan) inputs -->
                        <expand macro="input_conditional" label="Synteny data" format="paf" />
                        <expand macro="track_visibility" />
                    </when>

                    <when value="hic">
                        <!-- TODO no hic datatype by default, but input for hicConvertFormat? hic_matrix datatype on .eu -->
                        <expand macro="input_conditional" label="HiC data" format="hic" />
                        <expand macro="track_visibility" />
                    </when>

                    <when value="sparql">
                        <param type="text" label="SPARQL Server URL" name="url" />
                        <param type="text" label="Track Label" name="label" value="SPARQL Genes" />
                        <param type="text" label="SPARQL Query" name="query" area="true">
                            <sanitizer>
                                <mapping initial="galaxy.util.mapped_chars">
                                <add source="&#10;" target=" " />
                                <add source="&gt;" target="__gt__" />
                                <add source="&lt;" target="__lt__" />
                                </mapping>
                                <valid initial="default">
                                <add value="|" />
                                <add value="#" />
                                <add value="{"/>
                                <add value="}"/>
                                <add value="!"/>
                                <add value="?"/>
                                <add value="&amp;"/>
                                <add value="+"/>
                                <add value="="/>
                                <add value="'"/>
                                <add value='"'/>
                                </valid>
                            </sanitizer>
                        </param>
                        <param type="text" label="SPARQL reference names query" help="This query should return a line for each reference name in a `refName` column" name="query_refnames" area="true">
                            <sanitizer>
                                <mapping initial="galaxy.util.mapped_chars">
                                <add source="&#10;" target=" " />
                                <add source="&gt;" target="__gt__" />
                                <add source="&lt;" target="__lt__" />
                                </mapping>
                                <valid initial="default">
                                <add value="|" />
                                <add value="#" />
                                <add value="{"/>
                                <add value="}"/>
                                <add value="!"/>
                                <add value="?"/>
                                <add value="&amp;"/>
                                <add value="+"/>
                                <add value="="/>
                                <add value="'"/>
                                <add value='"'/>
                                </valid>
                            </sanitizer>
                        </param>
                        <expand macro="track_visibility" />
                    </when>
                </conditional>
            </repeat>
        </repeat>

        <expand macro="general_options" />

        <param type="hidden" name="uglyTestingHack" value="" />
    </inputs>
    <outputs>
        <!-- TODO create a jbrowse2 datatype -->
        <data format="html" name="output" label="JBrowse2 on $on_string"/>
    </outputs>
    <tests>
        <test>
            <param name="reference_genome|genome_type_select" value="history"/>
            <param name="reference_genome|genome" value="merlin.fa"/>
            <param name="uglyTestingHack" value="enabled" />
            <output name="output">
                <assert_contents>
                    <has_text text="genome path="></has_text>
                    <has_text text="dataset id="></has_text>
                    <has_text text="history id="></has_text>
                    <has_text text="metadata"></has_text>
                    <has_text text="tool_id"></has_text>
                </assert_contents>
            </output>
        </test>
        <test>
            <param name="reference_genome|genome_type_select" value="history"/>
            <param name="reference_genome|genome" value="merlin.fa"/>
            <repeat name="track_groups">
                <param name="category" value="Default" />
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="bed/test-3.bed,bed/test-6.bed"/>
                    </conditional>
                </repeat>
            </repeat>
            <param name="uglyTestingHack" value="enabled" />
            <output name="output">
                <assert_contents>
                    <has_text text="genome path="></has_text>
                    <has_text text="dataset id="></has_text>
                    <has_text text="history id="></has_text>
                    <has_text text="metadata"></has_text>
                    <has_text text="tool_id"></has_text>
                    <has_text text="trackFile path="></has_text>
                    <has_text text="ext=&quot;bed&quot; label=&quot;test-3.bed&quot;"></has_text>
                    <has_text text="NeatHTMLFeatures"></has_text>
                </assert_contents>
            </output>
        </test>
        <test>
            <param name="reference_genome|genome_type_select" value="history"/>
            <param name="reference_genome|genome" value="merlin.fa"/>
            <repeat name="track_groups">
                <param name="category" value="Auto Coloured" />
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/A.gff,gff3/B.gff,gff3/C.gff,gff3/D.gff"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="false"/>
                        </conditional>
                        <section name="jbcolor_scale">
                            <conditional name="color_score">
                                <param name="color_score_select" value="none"/>
                            </conditional>
                            <conditional name="color">
                                <param name="color_select" value="automatic"/>
                            </conditional>
                        </section>
                    </conditional>
                </repeat>
            </repeat>

            <repeat name="track_groups">
                <param name="category" value="Ignore Scale" />
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/1.gff"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="false"/>
                        </conditional>
                        <section name="jbcolor_scale">
                            <conditional name="color_score">
                                <param name="color_score_select" value="none"/>
                                <conditional name="color">
                                    <param name="color_select" value="manual"/>
                                    <param name="style_color" value="#ff00ff"/>
                                </conditional>
                            </conditional>
                        </section>
                    </conditional>
                </repeat>
            </repeat>

            <repeat name="track_groups">
                <param name="category" value="Scaled Colour" />
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/1.gff"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="false"/>
                        </conditional>
                        <section name="jbcolor_scale">
                            <conditional name="color_score">
                                <param name="color_score_select" value="score"/>
                                <param name="score_scaling" value="linear"/>
                                <conditional name="score_scales">
                                    <param name="scale_select" value="automatic"/>
                                </conditional>
                                <conditional name="color_scheme">
                                    <param name="score_scheme" value="opacity"/>
                                    <conditional name="color">
                                        <param name="color_select" value="automatic"/>
                                    </conditional>
                                </conditional>
                            </conditional>
                        </section>
                    </conditional>
                </repeat>
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/1.gff"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="false"/>
                        </conditional>
                        <section name="jbcolor_scale">
                            <conditional name="color_score">
                                <param name="color_score_select" value="score"/>
                                <param name="score_scaling" value="linear"/>
                                <conditional name="score_scales">
                                    <param name="scale_select" value="automatic"/>
                                </conditional>
                                <conditional name="color_scheme">
                                    <param name="score_scheme" value="opacity"/>
                                    <conditional name="color">
                                        <param name="color_select" value="manual"/>
                                        <param name="style_color" value="#0000ff"/>
                                    </conditional>
                                </conditional>
                            </conditional>
                        </section>
                    </conditional>
                </repeat>
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/1.gff"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="false"/>
                        </conditional>
                        <section name="jbcolor_scale">
                            <conditional name="color_score">
                                <param name="color_score_select" value="score"/>
                                <param name="score_scaling" value="linear"/>
                                <conditional name="score_scales">
                                    <param name="scale_select" value="manual"/>
                                    <param name="minimum" value="0"/>
                                    <param name="maximum" value="1000"/>
                                </conditional>
                                <conditional name="color_scheme">
                                    <param name="score_scheme" value="opacity"/>
                                    <conditional name="color">
                                        <param name="color_select" value="automatic"/>
                                    </conditional>
                                </conditional>
                            </conditional>
                        </section>
                    </conditional>
                </repeat>
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/1.gff"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="false"/>
                        </conditional>
                        <section name="jbcolor_scale">
                            <conditional name="color_score">
                                <param name="color_score_select" value="score"/>
                                <param name="score_scaling" value="linear"/>
                                <conditional name="score_scales">
                                    <param name="scale_select" value="manual"/>
                                    <param name="minimum" value="0"/>
                                    <param name="maximum" value="1000"/>
                                </conditional>
                                <conditional name="color_scheme">
                                    <param name="score_scheme" value="opacity"/>
                                    <conditional name="color">
                                        <param name="color_select" value="manual"/>
                                        <param name="style_color" value="#ff0000"/>
                                    </conditional>
                                </conditional>
                            </conditional>
                        </section>
                    </conditional>
                </repeat>
            </repeat>

            <repeat name="track_groups">
                <param name="category" value="Realistic" />
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/interpro.gff"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="false"/>
                        </conditional>
                        <section name="jbcolor_scale">
                            <conditional name="color_score">
                                <param name="color_score_select" value="none"/>
                            </conditional>
                            <conditional name="color">
                                <param name="color_select" value="automatic"/>
                            </conditional>
                        </section>
                    </conditional>
                </repeat>
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/2.gff"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="true"/>
                            <param name="name" value="cDNA_match"/>
                        </conditional>
                        <section name="jbcolor_scale">
                            <conditional name="color_score">
                                <param name="color_score_select" value="none"/>
                            </conditional>
                            <conditional name="color">
                                <param name="color_select" value="automatic"/>
                            </conditional>
                        </section>
                    </conditional>
                </repeat>
            </repeat>

            <param name="uglyTestingHack" value="enabled" />
            <output name="output">
                <assert_contents>
                        <has_text text="Auto Coloured"/>
                        <has_text text="A.gff"/>
                        <has_text text="B.gff"/>
                        <has_text text="C.gff"/>
                        <has_text text="D.gff"/>
                        <has_text text="Scaled Colour"/>
                        <has_text text="1.gff"/>
                        <has_text text="2.gff"/>
                </assert_contents>
            </output>
        </test>
        <test>
            <param name="reference_genome|genome_type_select" value="history"/>
            <param name="reference_genome|genome" value="merlin.fa"/>

            <repeat name="track_groups">
                <param name="category" value="With menu or index" />
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/1.gff"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="false"/>
                        </conditional>
                        <section name="jbcolor_scale">
                            <conditional name="color_score">
                                <param name="color_score_select" value="none"/>
                            </conditional>
                            <conditional name="color">
                                <param name="color_select" value="automatic"/>
                            </conditional>
                        </section>
                        <section name="jbmenu">
                            <repeat name="track_menu">
                                <param name="menu_action" value="iframeDialog"/>
                                <param name="menu_label" value="Some menu item"/>
                                <param name="menu_title" value="Frame title"/>
                                <param name="menu_url" value="https://example.com/#!/?id={name}&amp;q={type}&amp;z=&quot;{end}&quot;"/>
                                <param name="menu_icon" value="dijitIconNewTask"/>
                            </repeat>
                            <repeat name="track_menu">
                                <param name="menu_action" value="newWindow"/>
                                <param name="menu_label" value="Another menu item"/>
                                <param name="menu_title" value="Frame title 2"/>
                                <param name="menu_url" value="https://example.com/#!/?id={name}&amp;q={type}&amp;z=&quot;{end}&quot;"/>
                            </repeat>
                        </section>
                    </conditional>
                </repeat>
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/1.gff"/>
                        <param name="index" value="true"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="false"/>
                        </conditional>
                        <section name="jbcolor_scale">
                            <conditional name="color_score">
                                <param name="color_score_select" value="none"/>
                            </conditional>
                            <conditional name="color">
                                <param name="color_select" value="automatic"/>
                            </conditional>
                        </section>
                    </conditional>
                </repeat>
            </repeat>

            <param name="uglyTestingHack" value="enabled" />
            <output name="output">
                <assert_contents>
                    <has_text text="With menu or index"/>
                    <has_text text="Some menu item"/>
                    <has_text text="Frame title"/>
                    <has_text text="dijitIconNewTask"/>
                </assert_contents>
            </output>
        </test>
        <test>
            <param name="reference_genome|genome_type_select" value="history"/>
            <param name="reference_genome|genome" value="merlin.fa"/>

            <repeat name="track_groups">
                <param name="category" value="With canvas config" />
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/1.gff"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="false"/>
                        </conditional>
                        <conditional name="track_config">
                            <param name="track_class" value="JBrowse/View/Track/CanvasFeatures"/>
                            <section name="canvas_options">
                                <param name="transcriptType" value="transcript"/>
                                <param name="subParts" value="exon"/>
                                <param name="impliedUTRs" value="true"/>
                            </section>
                        </conditional>
                        <section name="jbcolor_scale">
                            <conditional name="color_score">
                                <param name="color_score_select" value="none"/>
                            </conditional>
                            <conditional name="color">
                                <param name="color_select" value="automatic"/>
                            </conditional>
                        </section>
                    </conditional>
                </repeat>
            </repeat>

            <param name="uglyTestingHack" value="enabled" />
            <output name="output">
                <assert_contents>
                    <has_text text="With canvas config"></has_text>
                    <has_text text="&lt;transcriptType&gt;transcript&lt;/transcriptType&gt;"></has_text>
                    <has_text text="&lt;subParts&gt;exon&lt;/subParts&gt;"></has_text>
                </assert_contents>
            </output>
        </test>
        <test>
            <param name="reference_genome|genome_type_select" value="history"/>
            <param name="reference_genome|genome" value="merlin.fa"/>

            <repeat name="track_groups">
                <param name="category" value="With custom track config" />
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="gene_calls"/>
                        <param name="annotation" value="gff3/1.gff"/>
                        <conditional name="match_part">
                            <param name="match_part_select" value="false"/>
                        </conditional>
                        <section name="jb_custom_config">
                            <repeat name="option">
                                <param name="opt_key" value="displayMode"/>
                                <conditional name="opt_value">
                                    <param name="val_type" value="text"/>
                                    <param name="val" value="collapsed"/>
                                </conditional>
                            </repeat>
                            <repeat name="option">
                                <param name="opt_key" value="histograms.height"/>
                                <conditional name="opt_value">
                                    <param name="val_type" value="integer"/>
                                    <param name="val" value="150"/>
                                </conditional>
                            </repeat>
                            <repeat name="option">
                                <param name="opt_key" value="maxFeatureScreenDensity"/>
                                <conditional name="opt_value">
                                    <param name="val_type" value="float"/>
                                    <param name="val" value="0.1"/>
                                </conditional>
                            </repeat>
                            <repeat name="option">
                                <param name="opt_key" value="style.strandArrow"/>
                                <conditional name="opt_value">
                                    <param name="val_type" value="boolean"/>
                                    <param name="val" value="false"/>
                                </conditional>
                            </repeat>
                        </section>
                    </conditional>
                </repeat>
            </repeat>

            <param name="uglyTestingHack" value="enabled" />
            <output name="output">
                <assert_contents>
                    <has_text text="1.gff"/>
                    <has_text text="collapsed"/>
                    <has_text text="150"/>
                    <has_text text="maxFeatureScreenDensity"/>
                    <has_text text="style.strandArrow"/>
                </assert_contents>
            </output>
        </test>
        <test>
            <param name="reference_genome|genome_type_select" value="history"/>
            <param name="reference_genome|genome" value="merlin.fa"/>

            <repeat name="track_groups">
                <param name="category" value="Auto Coloured" />
                <repeat name="data_tracks">
                    <conditional name="data_format">
                        <param name="data_format_select" value="pileup"/>
                        <param name="annotation" value="bam/merlin-sample.bam"/>
                    </conditional>
                </repeat>
            </repeat>

            <param name="uglyTestingHack" value="enabled" />
            <output name="output">
                <assert_contents>
                    <has_text text="merlin-sample.bam"/>
                    <has_text text="sort_order=&quot;coordinate&quot;"/>
                    <has_text text="bam_index"/>
                </assert_contents>
            </output>
        </test>
        <test>
            <!-- data_table -->
            <param name="reference_genome|genome_type_select" value="indexed"/>
            <param name="reference_genome|genome" value="merlin"/>
            <param name="uglyTestingHack" value="enabled" />
            <output name="output">
                <assert_contents>
                    <has_text text="merlin.fa"/>
                </assert_contents>
            </output>
        </test>
        <!-- TODO add a synteny test -->
        <!-- TODO add a cram test -->
        <!-- TODO add an hic test -->
        <!-- TODO add a vcf_bgzip test -->
    </tests>
    <!-- TODO update doc -->
    <help><![CDATA[
JBrowse-in-Galaxy
=================

JBrowse-in-Galaxy offers a highly configurable, workflow-compatible
alternative to Trackster.

Overview
--------

JBrowse is a fast, embeddable genome browser built completely with
JavaScript and HTML5.

The JBrowse-in-Galaxy (JiG) tool was written to help build complex
JBrowse installations straight from Galaxy, taking advantage of the
latest Galaxy features such as dataset collections, sections, and colour
pickers. It allows you to build up a JBrowse instance without worrying
about how to run the command line tools to format your data, and which
options need to be supplied and where. Additionally it comes with many
javascript functions to handle colouring of features which would be
nearly impossible to write without the assistance of this tool.

The JBrowse-in-Galaxy tool is maintained by `the Galaxy IUC
<https://github.com/galaxyproject/tools-iuc/issues>`__, who you can help you
with missing features or bugs in the tool.

Options
-------

The first option you encounter is the **Fasta Sequence(s)**. This option
now accepts multiple fasta files, allowing you to build JBrowse
instances that contain data for multiple genomes or chrosomomes
(generally known as "landmark features" in gff3 terminology.) Up to 30
will be shown from the dropdown selector within JBrowse, this is a known
issue.

**Genetic Code** is a new feature in v0.4 of JiG / v1.12.0 of JBrowse,
which allows users to specify a non standard genetic code, and have
JBrowse highlight the correct start and stop codons.

**Track Groups** represent a set of tracks in a single category. These
can be used to let your users understand relationships between large
groups of tracks.

.. image:: sections.png

Annotation Tracks
-----------------

Within Track Groups, you have one or more **Annotation Tracks**. Each
Annotation Track is a groups of datasets which have similar styling.
This allows you to rapidly build up JBrowse instances without having to
configure tracks individually. A massive improvement over previous
versions. For example, if you have five different GFF3 files from
various gene callers that you wish to display, you can take advantage of
this feature to style all of them similarly.

There are a few different types of tracks supported, each with their own
set of options:

GFF3/BED
~~~~~~~~

These are your standard feature tracks. They usually highlight genes,
mRNAs and other features of interest along a genomic region. The
underlying tool and this help documentation focus primarily on GFF3
data, and have not been tested extensively with other formats. Automatic
min/max detection will fail under BED datasets.

The data may be of a subclass we call **match/match part** data. This
consists of top level ``match`` features, with a child ``match_part``
feature, and is often used in displaying alignments. (See "Alignments"
section on the `GFF3
specification <https://github.com/The-Sequence-Ontology/Specifications/blob/master/gff3.md>`__ for more
information). If the data is match/match part, you will need to specify
the top level match feature name, as it can be one of a few different SO
terms, and JiG does not yet have the ability to understand SO terms.

Next up is the **Styling Options** section, which lets you control a few
properties on how the track is styled. Most of these you will not need
to configure and can safely leave on defaults. Occasionally you will
want to change what information is shown in the end product.

.. image:: styling.png

In the above image you can see some black text, and some blue text. The
source of the black text is configured with the **style.label** option,
and the source of the blue text is configured with the
**style.description** option.

Feature Score Scaling & Colouring Options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

First, you need to choose between ignoring the score attribute of GFF3
files, or using it. If you choose to ignore it, all features will be
coloured with a solid colour. If you choose to use it, features will
have slightly different colours based on their scores.

.. image:: opacity.png

If you choose **Ignore score**, you may choose between automatically
choosing a colour, or manually specifying one. The automatically chosen
colours vary along a brewer palette and generally look quite nice with
no human intervention required. The manual colour choice is somewhat
self explanatory. Clicking on the small coloured square will bring up a
colour palette.

If you choose **Base on score**, you're faced with a dizzying array of
options. First is the function to map the colour choices to colour
values. JiG comes with a few functions built in such as linear scaling,
logarithmic scaling, and blast scaling.

The **linear scaling** method says "take these values, and they map
directly to a range of output values". **Logarithmic scaling** says
"please take the log of the score before mapping", and **Blast scaling**
is further specialised to handle blast data more nicely. These are
convenience functions to help transform the wide array of possible
values in the GFF3 score attribute to more meaningful numbers. If you
need more comprehensive score scaling, it is recommended that you
pre-process your GFF3 files somehow.

Once you've selected a scaling method, you can choose to manually
specify the minimum and maximum expected values, or you can let JiG
determine them for you automatically.

Finally, opacity is the only mapping we currently provide. Future
iterations will attempt to improve upon this and provide more colour
scales. The Opacity option maps the highest scoring features to full
opacity, and everything else to lower ones.

BAM Pileups
~~~~~~~~~~~

We support BAM files and can automatically generate SNP tracks based on
that bam data.

.. image:: bam.png

This is *strongly discouraged* for high coverage density datasets.
Unfortunately there are no other configuration options exposed for bam
files.

BlastXML
~~~~~~~~

.. image:: blast.png

JiG now supports both blastn and blastp datasets. JiG internally uses a
blastXML to gapped GFF3 tool to convert your blastxml datasets into a
format amenable to visualization in JBrowse. This tool is also
available separately from the IUC on the toolshed.

**Minimum Gap Size** reflects how long a gap must be before it becomes a
real gap in the processed gff3 file. In the picture above, various sizes
of gaps can be seen. If the minimum gap size was set much higher, say
100nt, many of the smaller gaps would disappear, and the features on
both sides would be merged into one, longer feature. This setting is
inversely proportional to runtime and output file size. *Do not set this
to a low value for large datasets*. By setting this number lower, you
will have extremely large outputs and extremely long runtimes. The
default was configured based off of the author's experience, but the
author only works on small viruses. It is *strongly* recommended that
you filter your blast results before display, e.g. picking out the top
10 hits or so.

**Protein blast search** option merely informs underlying tools that
they should adjust feature locations by 3x.

Styling Options
^^^^^^^^^^^^^^^

Please see the styling options for GFF3 datasets, they are identical.

Feature Score Scaling & Coloring Options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Please see the score scaling and colouring options for GFF3 datasets,
they are identical. Remember to set your score scaling to "blast" method
if you do use it.

Bigwig XY
~~~~~~~~~

.. image:: bigwig.png

**XYPlot**

BigWig tracks can be displayed as a "density" plot which is continuous
line which varies in colour, or as an "XYplot." XYplots are preferable
for users to visually identify specific features in a bigwig track,
however density tracks are more visually compact.

**Variance Band** is an option available to XYPlots, and can be seen in
the third and fourth tracks in the above picture. This overlays a mean
line, and 1 and 2 standard deviation areas.

**Track Scaling** is different from colour scaling, instead it
configures how the track behaves inside of JBrowse. **Autoscaling
globally** means that JBrowse will determine the minimum and maximum for
the track, and fix the bounds of the viewport to that. E.g. if your
track ranges from 1-1000, and the region you're currently zoomed to only
goes from 0-50, then the viewport range will still show 1-1000. This is
good for global genomic context. However you may wish to consider
**autoscaling locally** instead. In the example of a region which varies
from 0-50, autoscaling locally would cause the individual track's
viewport to re-adjust and show just the 0-50 region. If neither of these
options are palatable, you may manually hardcode the minimum and
maximums for the track to scale to.

Colour Options
^^^^^^^^^^^^^^

BigWig tracks have two colours in JBrowse, a positive and a negative
colour.

As always you may manually choose a colour, or let JiG choose for you.

One of the more interesting options is the **Bicolor pivot**. This
option allows you to control the point at which JBrowse switches from
the positive colour to the negative. In the above graphic, you can see
this has been configured to "mean" for the first two (orange and blue)
tracks.

VCFs/SNPs
~~~~~~~~~

These tracks do not support any special configuration.

@ATTRIBUTION@
]]></help>
    <expand macro="citations"/>
</tool>