view eggnog_macros.xml @ 14:d9c3016f7283 draft default tip

planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 192779247c3385704ebd98a2cc47a210fb1f4d0c

<?xml version="1.0"?>
<macros>
   <token name="@TOOL_VERSION@">2.1.8</token>
   <token name="@VERSION_SUFFIX@">4</token>
   <token name="@EGGNOG_DB_VERSION@">5.0.2</token>
   <token name="@PROFILE@">22.01</token>
    <!--
    # DB versionning was super confusing for eggnog-mapper 2.0.x:
    # eggnog-mapper 1.* needed a db v4.5 (based on eggnog v4.5)
    # eggnog-mapper 2.x needed a db v2.0 (based on eggnog v5.0)
    # (db v4.5 are not compatible with eggnog-mapper 2.0)
    # Starting with eggnog-mapper 2.1.* db versioning looks better: 2.1.0 requires db v5.0.2
    -->
   <token name="@IDX_VERSION@">5.0.2</token>
   <xml name="citations">
        <citations>
            <citation type="doi">10.1093/nar/gkv1248</citation>
            <citation type="doi">10.1093/molbev/msx148</citation>
        </citations>
    </xml>
    <xml name="requirements">
        <requirements>
            <requirement type="package" version="@TOOL_VERSION@">eggnog-mapper</requirement>
        </requirements>
    </xml>
    <xml name="version_command">
        <version_command>emapper.py --version</version_command>
    </xml>
    <xml name="data_manager_params">
        <param name="test" type="hidden" value="false" />
        <param name="diamond_database" type="boolean" truevalue="" falsevalue="-D" checked="true" label="Install the diamond database" help="Takes ~9Gb, you most probably want it."/>
        <param name="mmseqs_database" type="boolean" truevalue="-M" falsevalue="" checked="true" label="Install the MMseqs2 database" help="Required for mmseqs seed ortholog search mode. Takes ~11Gb, you most probably want it."/>
        <param name="pfam_database" type="boolean" truevalue="-P" falsevalue="" checked="true" label="Install the Pfam database" help="Rquired for de novo annotation or realignment. Takes ~3Gb, you most probably want it."/>
    </xml>
    <xml name="data_manager_outputs">
        <outputs>
            <data name="out_file" format="data_manager_json" label="${tool.name}"/>
        </outputs>
    </xml>
    <token name="@DOWNLOAD_CMD@"><![CDATA[
## tool should set install_path
#if $test == 'true'
#import os.path
#set $install_path = $os.path.join($os.path.dirname($__tool_directory__), 'test-data/cached_locally')
#end if
mkdir -p '${install_path}' &&
download_eggnog_data.py
  $diamond_database $mmseqs_database $pfam_database -y -q
#if $test == 'true'
  -s
#end if
  --data_dir '$install_path' &&
python '${__tool_directory__}/data_manager_eggnog.py' --config_file '$out_file' --install_path '$install_path'
    ]]></token>
    <xml name="data_manager_test">
        <test>
            <param name="test" value="true"/>
            <param name="diamond_database" value="true"/>
            <yield />
            <output name="out_file">
                <assert_contents>
                    <has_text text="eggnog_mapper_db_versioned" />
                    <has_text text="@EGGNOG_DB_VERSION@" />
                </assert_contents>
            </output>
        </test>
    </xml>

    
    <xml name="stdout_assertion">
        <assert_stdout>
            <has_line line="#  emapper-@TOOL_VERSION@"/>
            <has_line line="FINISHED"/>
            <yield/>
        </assert_stdout>
    </xml>
    <xml name="db_macro">
        <param name="eggnog_data" type="select" label="Version of eggNOG Database">
            <options from_data_table="eggnog_mapper_db_versioned">
                <filter type="static_value" column="3" value="@IDX_VERSION@" />
            </options>
        </param>
    </xml>
    <token name="@DB_TOKEN@"><![CDATA[
        --data_dir '$eggnog_data.fields.path'
    ]]></token>

    <!-- macros and tokens for search -->
    
    <xml name="fasta_input">
        <param argument="-i" name="input" type="data" format="fasta" label="Fasta sequences to annotate"/>
        <conditional name="input_trans">
            <param argument="--itype" type="select" label="Type of sequences">
                <option value="proteins" selected="true">proteins</option>
                <option value="CDS">CDS</option>
                <option value="genome">genome</option>
                <option value="metagenome">metagenome</option>
            </param>
            <when value="proteins"/>
            <when value="CDS">
                <param argument="--translate" type="boolean" truevalue="--translate" falsevalue="" checked="false"
                    label="Translate CDS to proteins before search"/>
            </when>
            <when value="genome">
                <param argument="--translate" type="boolean" truevalue="--translate" falsevalue="" checked="false"
                    label="Translate predicted CDS from blastx hits to proteins"/>
                <param argument="--genepred" type="select" label="Type of sequences">
                    <option value="search">Inferred from Diamond/MMseqs2 blastx hits</option>
                    <option value="prodigal" selected="true">Performed using Prodigal</option>
                </param>
            </when>
            <when value="metagenome">
                <param argument="--translate" type="boolean" truevalue="--translate" falsevalue="" checked="false"
                    label="Translate predicted CDS from blastx hits to proteins"/>
                <param argument="--genepred" type="select" label="Type of sequences">
                    <option value="search">Inferred from Diamond/MMseqs2 blastx hits</option>
                    <option value="prodigal" selected="true">Performed using Prodigal</option>
                </param>
            </when>
        </conditional>
    </xml>
    <!-- Common options for search filtering (applies to diamond and mmseqs only) -->
    <xml name="common_search_options">
        <param argument="--query_cover" type="integer" optional="true" min="0" max="100" label="Minimum query coverage" help="Report only alignments above the given percentage of query cover" />
        <param argument="--subject_cover" type="integer" optional="true" min="0" max="100" label="Minimum subject coverage" help="Report only alignments above the given percentage of subject cover" />
        <param argument="--pident" type="integer" optional="true" min="0" max="100" label="Minimum query coverage" help="Report only alignments above the given percentage of identity" />
        <param argument="--evalue" type="float" optional="true" min="0" label="Minimum query coverage" help="Report only alignments below or equal the e-value" />
        <param argument="--score" type="float" value="0.001" optional="true" min="0" label="Minimum query coverage" help="Report only alignments above or equal the score" />
    </xml>

    <xml name="ortho_macro">
        <conditional name="ortho_method">
            <param argument="-m" type="select" label="Basis for annotation">
                <yield name="search_options"/>
                <yield name="reuse_options"/>
            </param>
            <yield name="search_whens"/>
            <yield name="reuse_whens"/>
        </conditional>
    </xml>

    <xml name="ortho_search_macro">
        <expand macro="ortho_macro">
            <token name="search_options">
                <expand macro="search_options_macro"/>
            </token>
            <token name="search_whens">
                <expand macro="search_whens_macro"/>
            </token>
        </expand>
    </xml>

    <xml name="ortho_annotate_macro">
        <expand macro="ortho_macro">
            <token name="reuse_options">
                <expand macro="reuse_options_macro"/>
            </token>
            <token name="reuse_whens">
                <expand macro="reuse_whens_macro"/>
            </token>
        </expand>
    </xml>

    <xml name="ortho_full_macro">
        <expand macro="ortho_macro">
            <token name="search_options">
                <expand macro="search_options_macro"/>
            </token>
            <token name="reuse_options">
                <expand macro="reuse_options_macro"/>
            </token>
            <token name="search_whens">
                <expand macro="search_whens_macro"/>
            </token>
            <token name="reuse_whens">
                <expand macro="reuse_whens_macro"/>
            </token>
        </expand>
    </xml>

    <xml name="search_options_macro">
        <option value="diamond">Seed orthologs computed with Diamond (diamond)</option>
        <option value="mmseqs">Seed orthologs computed with MMseqs2 (mmseqs)</option>
    </xml>

    <xml name="reuse_options_macro">
        <option value="no_search">Use existing seed orthologs (no_search)</option>
        <option value="cache">Use cached annotations (cache). See also --md5</option>
    </xml>

    <xml name="search_whens_macro">
        <when value="diamond">
            <expand macro="fasta_input"/>
            <conditional name="matrix_gapcosts">
                <param argument="--matrix" type="select" label="Scoring matrix and gap costs">
                    <option value="BLOSUM90">BLOSUM90</option>
                    <option value="BLOSUM80">BLOSUM80</option>
                    <option value="BLOSUM62" selected="true">BLOSUM62</option>
                    <option value="BLOSUM50">BLOSUM50</option>
                    <option value="BLOSUM45">BLOSUM45</option>
                    <option value="PAM250">PAM250</option>
                    <option value="PAM70">PAM70</option>
                    <option value="PAM30">PAM30</option>
                </param>
                <when value="BLOSUM90">
                    <param name="gap_costs" type="select" label="Gap Costs">
                        <option value="--gapopen 9 --gapextend 2">Existence: 9  Extension: 2</option>
                        <option value="--gapopen 8 --gapextend 2">Existence: 8  Extension: 2</option>
                        <option value="--gapopen 7 --gapextend 2">Existence: 7  Extension: 2</option>
                        <option value="--gapopen 6 --gapextend 2">Existence: 6  Extension: 2</option>
                        <option value="--gapopen 11 --gapextend 1">Existence: 11  Extension: 1</option>
                        <option value="--gapopen 10 --gapextend 1" selected="true">Existence: 10  Extension: 1</option>
                        <option value="--gapopen 9 --gapextend 1">Existence: 9  Extension: 1</option>
                    </param>
                </when>
                <when value="BLOSUM80">
                    <param name="gap_costs" type="select" label="Gap Costs">
                        <option value="--gapopen 8 --gapextend 2">Existence: 8  Extension: 2</option>
                        <option value="--gapopen 7 --gapextend 2">Existence: 7  Extension: 2</option>
                        <option value="--gapopen 6 --gapextend 2">Existence: 6  Extension: 2</option>
                        <option value="--gapopen 11 --gapextend 1">Existence: 11  Extension: 1</option>
                        <option value="--gapopen 10 --gapextend 1" selected="true">Existence: 10  Extension: 1</option>
                        <option value="--gapopen 9 --gapextend 1">Existence: 9  Extension: 1</option>
                    </param>
                </when>
                <when value="BLOSUM62">
                    <param name="gap_costs" type="select" label="Gap Costs">
                        <option value="--gapopen 11 --gapextend 2">Existence: 11  Extension: 2</option>
                        <option value="--gapopen 10 --gapextend 2">Existence: 10  Extension: 2</option>
                        <option value="--gapopen 9 --gapextend 2">Existence: 9  Extension: 2</option>
                        <option value="--gapopen 8 --gapextend 2">Existence: 8  Extension: 2</option>
                        <option value="--gapopen 7 --gapextend 2">Existence: 7  Extension: 2</option>
                        <option value="--gapopen 6 --gapextend 2">Existence: 6  Extension: 2</option>
                        <option value="--gapopen 13 --gapextend 1">Existence: 13  Extension: 1</option>
                        <option value="--gapopen 12 --gapextend 1">Existence: 12  Extension: 1</option>
                        <option value="--gapopen 11 --gapextend 1" selected="true">Existence: 11  Extension: 1</option>
                        <option value="--gapopen 10 --gapextend 1">Existence: 10  Extension: 1</option>
                        <option value="--gapopen 9 --gapextend 1">Existence: 9  Extension: 1</option>
                    </param>
                </when>
                <when value="BLOSUM50">
                    <param name="gap_costs" type="select" label="Gap Costs">
                        <option value="--gapopen 13 --gapextend 3">Existence: 13  Extension: 3</option>
                        <option value="--gapopen 12 --gapextend 3">Existence: 12  Extension: 3</option>
                        <option value="--gapopen 11 --gapextend 3">Existence: 11  Extension: 3</option>
                        <option value="--gapopen 10 --gapextend 3">Existence: 10  Extension: 3</option>
                        <option value="--gapopen 9 --gapextend 3">Existence: 9  Extension: 3</option>
                        <option value="--gapopen 16 --gapextend 2">Existence: 16  Extension: 2</option>
                        <option value="--gapopen 15 --gapextend 2">Existence: 15  Extension: 2</option>
                        <option value="--gapopen 14 --gapextend 2">Existence: 14  Extension: 2</option>
                        <option value="--gapopen 13 --gapextend 2" selected="true">Existence: 13  Extension: 2</option>
                        <option value="--gapopen 12 --gapextend 2">Existence: 12  Extension: 2</option>
                        <option value="--gapopen 19 --gapextend 1">Existence: 19  Extension: 1</option>
                        <option value="--gapopen 18 --gapextend 1">Existence: 18  Extension: 1</option>
                        <option value="--gapopen 17 --gapextend 1">Existence: 17  Extension: 1</option>
                        <option value="--gapopen 16 --gapextend 1">Existence: 16  Extension: 1</option>
                        <option value="--gapopen 15 --gapextend 1">Existence: 15  Extension: 1</option>
                    </param>
                </when>
                <when value="BLOSUM45">
                    <param name="gap_costs" type="select" label="Gap Costs">
                        <option value="--gapopen 13 --gapextend 3">Existence: 13  Extension: 3</option>
                        <option value="--gapopen 12 --gapextend 3">Existence: 12  Extension: 3</option>
                        <option value="--gapopen 11 --gapextend 3">Existence: 11  Extension: 3</option>
                        <option value="--gapopen 10 --gapextend 3">Existence: 10  Extension: 3</option>
                        <option value="--gapopen 15 --gapextend 2" selected="true">Existence: 15  Extension: 2</option>
                        <option value="--gapopen 14 --gapextend 2">Existence: 14  Extension: 2</option>
                        <option value="--gapopen 13 --gapextend 2">Existence: 13  Extension: 2</option>
                        <option value="--gapopen 12 --gapextend 2">Existence: 12  Extension: 2</option>
                        <option value="--gapopen 19 --gapextend 1">Existence: 19  Extension: 1</option>
                        <option value="--gapopen 18 --gapextend 1">Existence: 18  Extension: 1</option>
                        <option value="--gapopen 17 --gapextend 1">Existence: 17  Extension: 1</option>
                        <option value="--gapopen 16 --gapextend 1">Existence: 16  Extension: 1</option>
                    </param>
                </when>
                <when value="PAM250">
                    <param name="gap_costs" type="select" label="Gap Costs">
                        <option value="--gapopen 15 --gapextend 3">Existence: 15  Extension: 3</option>
                        <option value="--gapopen 14 --gapextend 3">Existence: 14  Extension: 3</option>
                        <option value="--gapopen 13 --gapextend 3">Existence: 13  Extension: 3</option>
                        <option value="--gapopen 12 --gapextend 3">Existence: 12  Extension: 3</option>
                        <option value="--gapopen 17 --gapextend 2">Existence: 17  Extension: 2</option>
                        <option value="--gapopen 16 --gapextend 2">Existence: 16  Extension: 2</option>
                        <option value="--gapopen 15 --gapextend 2">Existence: 15  Extension: 2</option>
                        <option value="--gapopen 14 --gapextend 2" selected="true">Existence: 14  Extension: 2</option>
                        <option value="--gapopen 13 --gapextend 2">Existence: 13  Extension: 2</option>
                        <option value="--gapopen 21 --gapextend 1">Existence: 21  Extension: 1</option>
                        <option value="--gapopen 20 --gapextend 1">Existence: 20  Extension: 1</option>
                        <option value="--gapopen 19 --gapextend 1">Existence: 19  Extension: 1</option>
                        <option value="--gapopen 18 --gapextend 1">Existence: 18  Extension: 1</option>
                        <option value="--gapopen 17 --gapextend 1">Existence: 17  Extension: 1</option>
                    </param>
                </when>
                <when value="PAM70">
                    <param name="gap_costs" type="select" label="Gap Costs">
                        <option value="--gapopen 12 --gapextend 3">Existence: 12 Extension: 3</option>
                        <option value="--gapopen 11 --gapextend 2">Existence: 11 Extension: 2</option>
                        <option value="--gapopen 8 --gapextend 2">Existence: 8  Extension: 2</option>
                        <option value="--gapopen 7 --gapextend 2">Existence: 7  Extension: 2</option>
                        <option value="--gapopen 6 --gapextend 2">Existence: 6  Extension: 2</option>
                        <option value="--gapopen 11 --gapextend 1">Existence: 11  Extension: 1</option>
                        <option value="--gapopen 10 --gapextend 1" selected="true">Existence: 10  Extension: 1</option>
                        <option value="--gapopen 9 --gapextend 1">Existence: 9  Extension: 1</option>
                    </param>
                </when>
                <when value="PAM30">
                    <param name="gap_costs" type="select" label="Gap Costs">
                        <option value="--gapopen 15 --gapextend 3">Existence: 15 Extension: 3</option>
                        <option value="--gapopen 13 --gapextend 3">Existence: 13 Extension: 3</option>
                        <option value="--gapopen 14 --gapextend 2">Existence: 14 Extension: 2</option>
                        <option value="--gapopen 7 --gapextend 2">Existence: 7  Extension: 2</option>
                        <option value="--gapopen 6 --gapextend 2">Existence: 6  Extension: 2</option>
                        <option value="--gapopen 5 --gapextend 2">Existence: 5  Extension: 2</option>
                        <option value="--gapopen 14 --gapextend 1">Existence: 14 Extension: 1</option>
                        <option value="--gapopen 10 --gapextend 1">Existence: 10  Extension: 1</option>
                        <option value="--gapopen 9 --gapextend 1" selected="true">Existence: 9  Extension: 1</option>
                        <option value="--gapopen 8 --gapextend 1">Existence: 8  Extension: 1</option>
                    </param>
                </when>
            </conditional>
            <param argument="--sensmode" type="select" label="Diamond's sensitivity mode">
                <option value="default">default</option>
                <option value="fast">fast</option>
                <option value="mid-sensitive">mid-sensitive</option>
                <option value="sensitive" selected="true">sensitive</option>
                <option value="more-sensitive">more-sensitive</option>
                <option value="very-sensitive">very-sensitive</option>
                <option value="ultra-sensitive">ultra-sensitive</option>
            </param>
            <param argument="--dmnd_iterate" type="boolean" truevalue="--dmnd_iterate yes" falsevalue="--dmnd_iterate no" checked="false"
                label="Run diamond in iterative mode, up to the sensitivity level"/>
            <param argument="--dmnd_ignore_warnings" type="boolean" truevalue="--dmnd_ignore_warnings" falsevalue="" checked="false"
                label="Ignore Diamond warnings on sequence content (e.g. when a protein contains only ATGC symbols)"/>
            <expand macro="common_search_options"/>
        </when>
        <when value="mmseqs">
            <expand macro="fasta_input"/>
            <param argument="--start_sens" type="integer" value="3" min="0" max="100" label="Starting sensitivity" />
            <param argument="--sens_steps" type="integer" value="3" min="0" max="100" label="Number of sensitivity steps" />
            <param argument="--final_sens" type="integer" value="7" min="0" max="100" label="Final sensititivy step" />
            <expand macro="common_search_options"/>
        </when>
    </xml>

    <xml name="reuse_whens_macro">
            <when value="no_search">
                <param argument="--annotate_hits_table" type="data" multiple="true" format="tabular" label="Seed orthologs">
                    <validator type="expression" message="No seed orthologs">value.metadata.columns == 11</validator>
                    <!-- would be cool to replace with this validator: 
                        <validator type="expression" message="No seed orthologs">value.metadata.column_names == '@SEED_ORTHOLOG_COLUMNS@'.split()</validator>
                        but this does not work (yet) in tool tests since column_names can not be set in uploads -->
                </param>
            </when>
            <when value="cache">
                <expand macro="fasta_input"/>
                <param argument="--cache"  type="data" format="tabular" label="EggNOG Annotations with md5 hashes" help="Annotations computed with EggNOG mapper with enabled --md5 option">
                    <validator type="expression" message="No seed orthologs">value.metadata.columns == 22</validator>
                </param>
                <param name="output_no_annotations" type="boolean" checked="true" label="Output sequences without annotation" help="Produce an additional FASTA file with the sequences of queries for which an existing annotation was not found using cache mode. This file can be used as input of another eggNOG-mapper run without using the cache, trying to annotate the sequences."/>
            </when>
    </xml>

    <token name="@MERGE_ANNOTATIONS@"><![CDATA[
        #if $ortho_method.m == "no_search"
            cat 
            #for aht in $ortho_method.annotate_hits_table
                $aht
            #end for
            > annotate_hits_table.tsv
            &&
        #end if
    ]]></token>

    <token name="@ORTHO_SEARCH_TOKEN@"><![CDATA[
        -m '$ortho_method.m'
        #if $ortho_method.m in ['diamond', 'mmseqs', 'cache']:
            -i '$ortho_method.input'
            --itype '$ortho_method.input_trans.itype'
            #if $ortho_method.input_trans.itype in ['CDS', 'genome', 'metagenome']:
                $ortho_method.input_trans.translate
            #end if
            #if $ortho_method.input_trans.itype in ['genome', 'metagenome']:
                --genepred $ortho_method.input_trans.genepred
            #end if
        #elif $ortho_method.m == "no_search"
            --annotate_hits_table annotate_hits_table.tsv
        #end if
        
        #if $ortho_method.m == 'cache'
            --cache '$ortho_method.cache'
        #end if
        #if $ortho_method.m == 'no_search'
            --annotate_hits_table annotate_hits_table.tsv
        #end if

        #if $ortho_method.m in ['diamond', 'mmseqs']:
            ## Diamond option
            #if $ortho_method.m == "diamond":
                --matrix '$ortho_method.matrix_gapcosts.matrix'
                $ortho_method.matrix_gapcosts.gap_costs
                --sensmode $ortho_method.sensmode
                $ortho_method.dmnd_iterate
                $ortho_method.dmnd_ignore_warnings
            #elif $ortho_method.m == "mmseqs":
                --start_sens $ortho_method.start_sens
                --sens_steps $ortho_method.sens_steps
                --final_sens $ortho_method.final_sens
            #end if

            ## Common options for search filtering (applies to diamond and mmseqs only)
            #if str($ortho_method.query_cover):
                --query_cover $ortho_method.query_cover
            #end if
            #if str($ortho_method.subject_cover):
                --subject_cover $ortho_method.subject_cover
            #end if
            #if str($ortho_method.pident):
                --pident $ortho_method.pident
            #end if
            #if str($ortho_method.evalue):
                --evalue $ortho_method.evalue
            #end if
            #if str($ortho_method.score):
                --score $ortho_method.score
            #end if
        #end if
    ]]></token>
    
    <!-- output options applying to search step -->
    <xml name="output_options_macro">
        <section name="output_options" expanded="false" title="Output Options">
            <param argument="--no_file_comments" type="boolean" truevalue="--no_file_comments" falsevalue="" checked="true"
                label="Exclude header lines and stats from output files"/>
            <yield/>
        </section>
    </xml>
    <!-- output options applying search and annotate step -->
    <xml name="output_options_annotate_macro">
        <expand macro="output_options_macro">
            <param argument="--report_orthologs" type="boolean" truevalue="--report_orthologs" falsevalue="" checked="false" label="Output a file with the list of orthologs for each hit"/>
            <param argument="--md5" type="boolean" truevalue="--md5" falsevalue="" checked="false" label="Add md5 hash of each query to annotations"/>
        </expand>
    </xml>

    <token name="@SEED_ORTHOLOG_COLUMNS@">query_name,seed_eggNOG_ortholog,seed_ortholog_evalue,seed_ortholog_score,query_start,query_end,seed_start,seed_end,pident,query_cov,seed_cov</token>

    <xml name="ortho_search_output_macro">
        <data name="seed_orthologs" format="tabular" label="${tool.name} on ${on_string}: seed_orthologs" from_work_dir="results.emapper.seed_orthologs">
            <filter>ortho_method['m'] not in ['no_search', 'cache']</filter>
            <actions>
                <action name="column_names" type="metadata" default="@SEED_ORTHOLOG_COLUMNS@"/>
            </actions>
        </data>
    </xml>

    <xml name="seed_orthologs_assertion" token_nocomments="true">
        <output name="seed_orthologs" ftype="tabular">
            <assert_contents>
                <has_line line="#qseqid&#009;sseqid&#009;evalue&#009;bitscore&#009;qstart&#009;qend&#009;sstart&#009;send&#009;pident&#009;qcov&#009;scov"/>
                <has_line_matching expression="(\S+\t){2}[-+.e\d]+\t[.\d]+(\t\d+){4}(\t[.\d]+){3}" n="1"/>
                <has_line_matching expression="##.*" negate="@NOCOMMENTS@"/>
            </assert_contents>
        </output>
    </xml>
    
    <token name="@HELP_SEARCH_OUTPUTS@"><![CDATA[
        **seed orthologs**
        
        each line in the file provides the best match of each query within the best Orthologous Group (OG)
        reported in the [project].hmm_hits file, obtained running PHMMER against all sequences within the best OG.
        The seed ortholog is used to fetch fine-grained orthology relationships from eggNOG.
        If using the diamond search mode, seed orthologs are directly
        obtained from the best matching sequences by running DIAMOND against the whole eggNOG protein space.
    ]]></token>

    <!-- macros and tokens for annotate -->

    <xml name="annotation_options_macro">
        <param argument="--seed_ortholog_evalue" type="float" value="0.001" min="0" label="Min E-value threshold">
            <help>
            Min E-value expected when searching for seed eggNOG ortholog. Applies to phmmer/diamond searches.
            Queries not having a significant seed orthologs (E-value less than threshold) will not be annotated.
            </help>
        </param>
        <param argument="--seed_ortholog_score" type="float" optional="true" min="0" label="Minimum bit score threshold">
            <help>
            Min bit score expected when searching for seed eggNOG ortholog.
            Queries not having a significant seed orthologs will not be annotated.
            </help>
        </param>
        <param argument="--tax_scope" type="integer" optional="true" label="Set taxonomic scope" help="NCBI taxonomy id" />
        <param argument="--target_orthologs" type="select" label="target orthologs for functional transfer">
            <option value="one2one">one2one</option>
            <option value="many2one">many2one</option>
            <option value="one2many">one2many</option>
            <option value="many2many">many2many</option>
            <option value="all" selected="true">all</option>
        </param>
        <param argument="--go_evidence" type="select"
                label="Select the set of GO terms that should be used for annotation">
            <option value="experimental">experimental = Use only terms inferred from experimental evidence</option>
            <option value="non-electronic" selected="true">non-electronic = Use only non-electronically curated terms</option>
            <option value="all" selected="true">All (experimental + non-electronic)</option>
        </param>
    </xml>
    <token name="@ANNOTATION_TOKEN@"><![CDATA[
    #if str($annotation_options.seed_ortholog_evalue):
        --seed_ortholog_evalue $annotation_options.seed_ortholog_evalue
    #end if
    #if str($annotation_options.seed_ortholog_score):
        --seed_ortholog_score $annotation_options.seed_ortholog_score
    #end if
    #if $annotation_options.tax_scope:
        --tax_scope=$annotation_options.tax_scope
    #end if
    #if $annotation_options.target_orthologs:
        --target_orthologs=$annotation_options.target_orthologs
    #end if
    #if $annotation_options.go_evidence:
        --go_evidence=$annotation_options.go_evidence
    #end if
    \$EGGNOG_DBMEM
    ]]></token>
    <xml name="annotation_output_macro">
        <data name="annotations" format="tabular" label="${tool.name} on ${on_string}: annotations" from_work_dir="results.emapper.annotations">
            <yield/>
            <actions>
                <conditional name="output_options.md5">
                    <when value="True">
                        <action name="column_names" type="metadata" default="query,seed_ortholog,evalue,score,max_annot_lvl,COG_category,Description,Preferred_name,GOs,EC,KEGG_ko,KEGG_Pathway,KEGG_Module,KEGG_Reaction,KEGG_rclass,BRITE,KEGG_TC,CAZy,BiGG_Reaction,PFAMseggNOG_OGs,md5"/>
                    </when>
                    <when value="False">
                        <action name="column_names" type="metadata" default="query,seed_ortholog,evalue,score,max_annot_lvl,COG_category,Description,Preferred_name,GOs,EC,KEGG_ko,KEGG_Pathway,KEGG_Module,KEGG_Reaction,KEGG_rclass,BRITE,KEGG_TC,CAZy,BiGG_Reaction,PFAMseggNOG_OGs"/>
                    </when>
                </conditional>
            </actions>
        </data>
        <data name="no_annotations" format="fasta" label="${tool.name} on ${on_string}: sequences without annotation"  from_work_dir="results.emapper.no_annotations.fasta">
            <filter>ortho_method['m'] == 'cache' and ortho_method['output_no_annotations']</filter>
        </data>
    </xml>

    <xml name="annotation_orthologs_output_macro">
        <data name="annotations_orthologs" format="tabular" label="${tool.name} on ${on_string}: orthologs"  from_work_dir="results.emapper.orthologs">
            <filter>ortho_method['m'] != 'cache'</filter>
            <filter>output_options['report_orthologs']</filter>
            <actions>
                <action name="column_names" type="metadata" default="query,orth_type,species,orthologs"/>
            </actions>
        </data>
    </xml>

    <xml name="annotations_assertion" token_columns="21" token_add_metadata_columm_names="" token_add_column_names="" token_add_column_re="" token_nocomments="true">
        <output name="annotations" ftype="tabular">
            <metadata name="columns" value="@COLUMNS@" />
            <!-- <metadata name="column_names" value="query,seed_ortholog,evalue,score,max_annot_lvl,COG_category,Description,Preferred_name,GOs,EC,KEGG_ko,KEGG_Pathway,KEGG_Module,KEGG_Reaction,KEGG_rclass,BRITE,KEGG_TC,CAZy,BiGG_Reaction,PFAMseggNOG_OGs@ADD_METADATA_COLUMN_NAMES@" /> -->
            <assert_contents>
                <has_line line="#query&#009;seed_ortholog&#009;evalue&#009;score&#009;eggNOG_OGs&#009;max_annot_lvl&#009;COG_category&#009;Description&#009;Preferred_name&#009;GOs&#009;EC&#009;KEGG_ko&#009;KEGG_Pathway&#009;KEGG_Module&#009;KEGG_Reaction&#009;KEGG_rclass&#009;BRITE&#009;KEGG_TC&#009;CAZy&#009;BiGG_Reaction&#009;PFAMs@ADD_COLUMN_NAMES@"/>
                <has_line_matching expression="(\S+\t){2}[-+.e\d]+\t[.\d]+(\t\S+){7}\tko:\S+(\t\S+){9}@ADD_COLUMN_RE@" n="1"/>
                <has_line_matching expression="##.*" negate="@NOCOMMENTS@"/>
            </assert_contents>
        </output>
    </xml>
    <xml name="annotations_orthologs_assertion" token_nocomments="true">
        <output name="annotations_orthologs" ftype="tabular">
            <metadata name="columns" value="4" />
            <metadata name="column_names" value="query,orth_type,species,orthologs" />
            <assert_contents>
                <has_line line="#query&#009;orth_type&#009;species&#009;orthologs"/>
                <has_line_matching expression="\S+\t(one2one|many2one|one2many|many2many|seed)(\t[^\t]+){2}" n="2"/>
                <has_line_matching expression="##.*" negate="@NOCOMMENTS@"/>
            </assert_contents>
        </output>
    </xml>
    <token name="@HELP_ANNOTATION_OUTPUTS@"><![CDATA[
        **annotations**

        This file provides final annotations of each query. Tab-delimited columns in the file are:
        
        - ``query_name``: query sequence name
        - ``seed_eggNOG_ortholog``: best protein match in eggNOG
        - ``seed_ortholog_evalue``: best protein match (e-value)
        - ``seed_ortholog_score``: best protein match (bit-score)
        - ``predicted_taxonomic_group``
        - ``predicted_protein_name``: Predicted protein name for query sequences
        - ``GO_terms``: Comma delimited list of predicted Gene Ontology terms
        - ``EC_number``
        - ``KEGG_KO``
        - ``KEGG_Pathway``: Comma delimited list of predicted KEGG pathways
        - ``KEGG_Module``
        - ``KEGG_Reaction``
        - ``KEGG_rclass``
        - ``BRITE``
        - ``KEGG_TC``
        - ``CAZy``
        - ``BiGG_Reactions``
        - ``Annotation_tax_scope``: The taxonomic scope used to annotate this query sequence
        - ``Matching_OGs``: Comma delimited list of matching eggNOG Orthologous Groups
        - ``best_OG|evalue|score``: Best matching Orthologous Groups (deprecated, use smallest from eggnog OGs)
        - ``COG_functional_categories``: COG functional category inferred from best matching OG
        - ``eggNOG_free_text_description``
        
        **orthologs**

        This output is only created if the option ``--report_orthologs`` is checked.
        It provides the orthologs used for the annotation. It's a tab delimited file with the following columns:
        
        - ``query``
        - ``orth_type`` Type of orthologs in this row. See --target_orthologs.
        - ``species``
        - ``orthologs`` comma-separated list of orthologs (If an ortholog shows a "*", such ortholog was used to transfer its annotations to the query.)
        
        **sequences without annotation **

        This output is created if cached annotations are used as input. 
        It is a FASTA file containing all sequences that are not found in the cached annotations.
        These sequences can then be used as input for another run of the EggNOG mapper
        computing seed orthologs with diamond, etc.
    ]]></token>
</macros>