annotate fimo.xml @ 14:c1a9a297ba8b draft

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

<tool id="meme_fimo" name="FIMO" version="@WRAPPER_VERSION@.0">
    <description>- Scan a set of sequences for motifs</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements" />
    <command detect_errors="exit_code"><![CDATA[
fimo
    -o ./out/
    $scanrc
    #if str( $options_type.options_type_selector ) == 'advanced':
        --thresh $options_type.thresh
        $options_type.qv_thresh
        #if str( $options_type.bgfile_type.bgfile_type_selector ) == 'motif_file':
            --bgfile --motif--
        #elif str( $options_type.bgfile_type.bgfile_type_selector ) == 'bgfile':
            --bgfile $options_type.bgfile_type.bgfile
        #elif str( $options_type.bgfile_type.bgfile_type_selector ) == 'uniform_distr':
            --bgfile --uniform--
        #end if
        $options_type.max_strand
        --max-stored-scores $options_type.max_stored_scores

        #if str( $options_type.motifs_cond.motif_selector) == 'yes':
            #for $motif in $options_type.motifs_cond.motifs:
                --motif '$motif.motif'
            #end for
        #end if

        --motif-pseudo $options_type.motif_pseudo
        $options_type.no_qvalue
        $options_type.parse_genomic_coords
        
        #if str( $options_type.psp_cond.psp_selector ) == 'yes':
            --psp $options_type.psp_cond.input_psp
            --alpha $options_type.psp_cond.alpha
        #end if

        #if str( $options_type.prior_dist_cond.prior_dist_selector ) == 'yes':
            --prior-dist $options_type.prior_dist_cond.input_prior_dist
        #end if
    #end if
    '$input_motifs'
    #if str($fasta_type.fasta_type_selector) == 'history':
        '${fasta_type.input_database}'
    #else:
        '${fasta_type.input_database.fields.path}'
    #end if
&& mv ./out/fimo.html '${html_outfile}'
&& mv ./out/fimo.txt '${txt_outfile}'
&& mv ./out/fimo.xml '${xml_outfile}'
&& mv ./out/fimo.gff '${gff_outfile}'
    ]]></command>
    <inputs>
        <param name="input_motifs" type="data" format="memexml" label="DREME or MEME output XML file"
               help="DREME or MEME output XML file containing found motifs"/>
        <conditional name="fasta_type">
            <param name="fasta_type_selector" type="select" label="Source for sequence to search">
                <option value="cached">Locally Cached sequences</option>
                <option value="history" selected="true">Sequences from your history</option>
            </param>
            <when value="cached">
                <param name="input_database" type="select" label="Genome to search">
                    <options from_data_table="all_fasta" />
                </param>
            </when>
            <when value="history">
                <param format="fasta" name="input_database" type="data" label="Sequences"/>
            </when>
        </conditional>
        <param name="scanrc" label="Check reverse complement strand" type="boolean"
               truevalue="" falsevalue="--norc" checked="False"
               help="Search for motifs also on reverse complement strand"/>
        <conditional name="options_type">
            <param name="options_type_selector" type="select" label="Options configuration">
                <option value="basic" selected="true">Basic</option>
                <option value="advanced">Advanced</option>
            </param>
            <when value="basic"/>
            <when value="advanced">
                <param name="thresh" type="float" value="1e-4" argument="--thresh"
                label="Output threshold for displaying search results" 
                help="Only output results with a p-value less than the given threshold. To apply set threshold to q-values rather than p-values, set --qv-thresh."/>
                <param name="qv_thresh" label="Apply output threshold to q-values?" argument="--qv-thresh"
                       type="boolean" truevalue="--qv_thresh" falsevalue="" checked="False" 
                       help="Default: apply set threshold on p-values"/>
                <conditional name="bgfile_type">
                    <param name="bgfile_type_selector" type="select" label="Background model selection">
                        <option value="default" selected="true">Use embedded letter frequencies from non-redundant DNA/protein database</option>
                        <option value="motif_file">Use 0-order letter frequencies from motif file</option>
                        <option value="bgfile">Use 0-order letter frequencies from background file</option>
                        <option value="uniform_distr">Use uniform letter frequencies</option>
                    </param>
                    <when value="motif_file" />
                    <when value="default" />
                    <when value="uniform_distr" />
                    <when value="bgfile">
                        <param name="bgfile" type="data" format="txt" optional="True" label="Background model file" help="File must be in Markov background model format (see MEME suite tool fasta-get-markov for details)"/>
                    </when>
                </conditional>
                <param name="max_strand" label="Report best match in case of overlapping matches on both strands?" argument="--max-strand"
                       type="boolean" truevalue="--max-strand" falsevalue="" checked="False" 
                       help="If matches on both strands at a given position satisfy the output threshold, only report the match for the strand with the higher score. If the scores are tied, the matching strand is chosen at random (default: report both matches)."/>
                <param name="max_stored_scores" type="integer" value="100000" argument="--max-stored-scores"
                label="Maximum number of scores that will be stored"
                help="Keeping a complete list of scores may exceed available memory. Once the number of stored scores reaches the maximum allowed, the least significant 50% of scores will be dropped. In this case, the list of reported motifs may be incomplete and the q-value calculation will be approximate."/>
                <conditional name="motifs_cond">
                    <param name="motif_selector" type="select" label="Specify single input motifs for scanning?">
                        <option value="no" selected="true">No</option>
                        <option value="yes">Yes</option>
                    </param>
                    <when value="no"/>
                    <when value="yes">
                        <repeat name="motifs" title="Supply input motif ID">
                            <param name="motif" type="text" value="" label="Specify motif by id">
                                <validator type="empty_field" />
                                <validator type="regex" message="Value may include alphanumeric characters.">[A-Za-z]+</validator>
                            </param>
                        </repeat>
                    </when>
                </conditional>
                <param name="motif_pseudo" type="float" value="0.1" argument="--motif-pseudo"
                       label="Pseudocount to add to counts in motif matrix" 
                       help="A pseudocount to be added to each count in the motif matrix, after first multiplying by the corresponding background frequency"/>
                <param name="no_qvalue" label="Disable q-value calculation?" 
                       type="boolean" truevalue="--no-qvalue" falsevalue="" checked="False" argument="--no-qvalue"
                       help="The q-value calculation is that of Benjamini and Hochberg (1995) (default: calculate q-value for each p-value)"/>
                <param name="parse_genomic_coords" label="Check each sequence header for UCSC-style genomic coordinates?" 
                       type="boolean" truevalue="--parse-genomic-coord" falsevalue="" checked="False" argument="--parse-genomic-coord"
                       help=" If genomic coordinates are found they will be used as the coordinates in the output."/>
                <conditional name="psp_cond">
                    <param name="psp_selector" type="select" label="Use position-specific priors?">
                        <option value="no" selected="true">No</option>
                        <option value="yes">Yes</option>
                    </param>
                    <when value="no"/>
                    <when value="yes">
                        <param name="input_psp" type="data" format="txt" argument="--psp"
                               label="Select file containing position-specific priors" 
                               help="File should be in MEME PSP format or wiggle format (can be generated by MEME suite tool create-priors)"/>
                        <param name="alpha" type="float" value="1.0" min="0" max="1.0" argument="--alpha"
                               label="Alpha parameter for calculating position-specific priors"
                               help="Represents the fraction of all transcription factor binding sites that are binding sites for the TF of interest (must be between 0 and 1)"/>
                    </when>
                </conditional>
                <conditional name="prior_dist_cond">
                    <param name="prior_dist_selector" type="select" label="Use binned distribution of priors?">
                        <option value="no" selected="true">No</option>
                        <option value="yes">Yes</option>
                    </param>
                    <when value="no"/>
                    <when value="yes">
                        <param name="input_prior_dist" type="data" format="txt" argument="--prior-dist"
                               label="Select dataset containing binned distribution of priors"
                               help="This file can be generated using the MEME suite tool create-priors"/>
                    </when>
                </conditional>
            </when>
        </conditional>
        <param name="non_commercial_use" label="I certify that I am not using this tool for commercial purposes." type="boolean" truevalue="NON_COMMERCIAL_USE" falsevalue="COMMERCIAL_USE" checked="False">
            <validator type="expression" message="This tool is only available for non-commercial use.">value == True</validator>
        </param>
        <section name="output_options" title="Additional output options">
            <param name="html_outfile" type="boolean" value="False" label="Output HTML file" help="FIMO HTML output file"/>
            <param name="xml_outfile" type="boolean" value="False" label="Output XML file" help="FIMO XML output file"/>
            <param name="gff_outfile" type="boolean" value="False" label="Output GFF file" help="FIMO GFF output file"/>
        </section>
    </inputs>
    <outputs>
        <data format="txt" name="txt_outfile" label="${tool.name} on ${on_string} (text)">
            <actions>
                <conditional name="fasta_type.fasta_type_selector">
                    <when value="cached">
                        <action type="metadata" name="dbkey">
                            <option type="from_data_table" name="all_fasta" column="1" offset="0">
                                <filter type="param_value" ref="fasta_type.input_database" column="0"/>
                            </option>
                        </action>
                    </when>
                </conditional>
            </actions>
        </data>
        <data format="html" name="html_outfile" label="${tool.name} on ${on_string} (html)">
            <filter>(output_options['html_outfile'] is True)</filter>
            <actions>
                <conditional name="fasta_type.fasta_type_selector">
                    <when value="cached">
                        <action type="metadata" name="dbkey">
                            <option type="from_data_table" name="all_fasta" column="1" offset="0">
                                <filter type="param_value" column="0" value="seq" keep="True"/>
                                <filter type="param_value" ref="fasta_type.input_database" column="1"/>
                            </option>
                        </action>
                    </when>
                </conditional>
            </actions>
        </data>
        <data format="txt" name="gff_outfile" label="${tool.name} on ${on_string} (gff)">
            <filter>(output_options['gff_outfile'] is True)</filter>
            <actions>
                <conditional name="fasta_type.fasta_type_selector">
                    <when value="cached">
                        <action type="metadata" name="dbkey">
                            <option type="from_data_table" name="all_fasta" column="1" offset="0">
                                <filter type="param_value" ref="fasta_type.input_database" column="0"/>
                            </option>
                        </action>
                    </when>
                </conditional>
            </actions>
        </data>
        <data format="memexml" name="xml_outfile" label="${tool.name} on ${on_string} (xml)">
            <filter>(output_options['xml_outfile'] is True)</filter>
            <actions>
                <conditional name="fasta_type.fasta_type_selector">
                    <when value="cached">
                        <action type="metadata" name="dbkey">
                            <option type="from_data_table" name="all_fasta" column="1" offset="0">
                                <filter type="param_value" ref="fasta_type.input_database" column="0"/>
                            </option>
                        </action>
                    </when>
                </conditional>
            </actions>
        </data>
    </outputs>
    <tests>
        <test expect_num_outputs="4">
            <param name="input_motifs" value="meme_fimo_input_1.xml" ftype="memexml"/>
            <param name="fasta_type_selector" value="history"/>
            <param name="input_database" value="hsa_chrM.fa" ftype="fasta"/>
            <param name="scanrc" value="true"/>
            <param name="options_type_selector" value="basic"/>
            <param name="html_outfile" value="True"/>
            <param name="xml_outfile" value="True"/>
            <param name="gff_outfile" value="True"/>
            <param name="non_commercial_use" value="True"/>
            <output name="html_outfile" file="fimo_output_test1.html" lines_diff="20"/>
            <output name="txt_outfile" file="fimo_output_test1.txt"/>
            <output name="xml_outfile" file="fimo_output_test1.xml" lines_diff="20"/>
            <output name="gff_outfile" file="fimo_output_test1.gff"/>
        </test>
        <test expect_num_outputs="4">
            <param name="input_motifs" value="dreme_fimo_input_1.xml" ftype="memexml"/>
            <param name="fasta_type_selector" value="history"/>
            <param name="input_database" value="hsa_chrM.fa" ftype="fasta"/>
            <param name="scanrc" value="true"/>
            <param name="options_type_selector" value="advanced"/>
            <param name="bgfile_type_selector" value="bgfile"/>
            <param name="bgfile" value="fimo_background_probs_hsa_chrM.txt"/>
            <param name="html_outfile" value="True"/>
            <param name="xml_outfile" value="True"/>
            <param name="gff_outfile" value="True"/>
            <param name="non_commercial_use" value="True"/>
            <output name="html_outfile" file="fimo_output_test2.html" lines_diff="20"/>
            <output name="txt_outfile" file="fimo_output_test2.txt"/>
            <output name="xml_outfile" file="fimo_output_test2.xml" lines_diff="20"/>
            <output name="gff_outfile" file="fimo_output_test2.gff"/>
        </test>
        <test expect_num_outputs="3">
            <param name="input_motifs" value="dreme_fimo_input_1.xml" ftype="memexml"/>
            <param name="fasta_type_selector" value="history"/>
            <param name="input_database" value="hsa_chrM.fa" ftype="fasta"/>
            <param name="scanrc" value="true"/>
            <param name="options_type_selector" value="advanced"/>
            <param name="thresh" value="0.01"/>
            <param name="bgfile_type_selector" value="uniform_distr"/>
            <param name="motif_selector" value="yes"/>
            <repeat name="motifs">
                <param name="motif" value="ACTAAYH"/>
            </repeat>
            <param name="html_outfile" value="True"/>
            <param name="xml_outfile" value="True"/>
            <param name="gff_outfile" value="False"/>
            <param name="non_commercial_use" value="True"/>
            <output name="html_outfile" file="fimo_output_test3.html" lines_diff="20"/>
            <output name="txt_outfile" file="fimo_output_test3.txt"/>
            <output name="xml_outfile" file="fimo_output_test3.xml" lines_diff="20"/>
        </test>
    </tests>
    <help>

.. class:: warningmark

**WARNING: This tool is only available for non-commercial use. Use for educational, research and non-profit purposes is permitted.
Before using, be sure to review, agree, and comply with the license.**

FIMO scans a sequence database for individual matches to each of the motifs you provide (sample output for motifs and sequences).
The name FIMO stands for 'Find Individual Motif Occurrences'.  The program searches a database of sequences for occurrences of
known motifs, treating each motif independently.  Motifs must be in MEME Motif Format.  You can define the statistical threshold
(p-value) for motifs and whether FIMO scans just the given sequences or their reverse complements (where applicable).

.. class:: infomark

For detailed information on FIMO, click here_, or view the license_.

.. _here: http://meme-suite.org/doc/fimo.html?man_type=web
.. _license: http://meme-suite.org/doc/copyright.html?man_type=web

    </help>
    <citations>
        <citation type="doi">10.1093/bioinformatics/btr064</citation>
    </citations>
</tool>