annotate goprofiles.xml @ 0:6eeb2fb0c4bd draft default tip

planemo upload

<tool id="goProfiles" name="goProfilesP" version="0.1.0">
    <description> Identify enriched biological themes, GO terms from your protein list.
    </description>
    <requirements>
        <!--requirement type="package" version="3.3.0">bioconductor-org.hs.eg.db</requirement>
        <requirement type="package" version="1.38.0">goprofiles</requirement-->
    </requirements>
    <stdio>
        <exit_code range="1:" />
    </stdio>
    <command><![CDATA[
        Rscript $__tool_directory__/goprofiles.R
        #if $input.ids == "text"
            "$input.text" "text"
        #else 
            "$input.file,$input.ncol,$input.header" "file"
        #end if
        
        $input.id_type
        
        $onto_opt
        
        $opt.plot_opt
        
        $level
        
        $per
        
        "$title"

    ]]></command>
    <inputs>
        <conditional name="input" >
            <param name="ids" type="select" label="Provide your Entrez Gene or UniProt identifiers" help="Copy/paste or ID list from a file (e.g. table)" >
                <option value="text">Copy/paste your identifiers</option>
                <option value="file">Input file containing your identifiers</option>
            </param>
            <when value="text" >
                <param name="text" type="text" label="Copy/paste your identifiers" help='IDs must be separated by spaces into the form field, for example: P31946 P62258' >
                    <sanitizer>
                        <valid initial="string.printable">
                            <remove value="&apos;"/>
                        </valid>
                        <mapping initial="none">
                            <add source="&apos;" target="__sq__"/>
                        </mapping>
                    </sanitizer>
                </param>
                <param name="id_type" type="select" label="Please select the type of your IDs list" >
                    <option value="Entrez">Entrez Gene ID</option>
                    <option value="UniProt">UniProt protein ID</option>
                </param>
            </when>
            <when value="file" >
                <param name="file" type="data" format="txt,tabular" label="Choose a file that contains your list of IDs" help="" />
                <param name="ncol" type="text" label="The column number of IDs to use" help='For example, fill in "c1" if it is the first column, "c2" if it is the second column and so on' />
                <param name="header" type="boolean" checked="true" truevalue="true" falsevalue="false" label="Does your input file contain header?" />
                <param name="id_type" type="select" label="Please select the type of your IDs list" >
                    <option value="Entrez">Entrez Gene ID</option>
                    <option value="UniProt">UniProt protein ID</option>
                </param>
            </when>
            
        </conditional>
        <param type="select" name="onto_opt" label="Please select GO terms category" multiple="True" display="checkboxes" >
            <option value="CC">Cellular Component (CC)</option>
            <option value="MF">Molecular Function (MF)</option>
            <option value="BP">Biological Process (BP)</option>
        </param>
        <param type="select" name="level" label="Level of the ontology at which the profile has to be built (the higher this number, the deeper the GO level)" >
            <option value="1">1</option>
            <option value="2" selected="True">2</option>
            <option value="3">3</option>
        </param>
        <param type="boolean" name="per" label="Plot absolute or relative frequencies (not summing to 100)" truevalue="TRUE" falsevalue="FALSE" />
        <param type="text" name="title" label="Enter title of your figure" />
        <section name="opt" title="Choose graphical output (bar plots) format: png, jpeg, pdf" expanded="False" help="By default, PDF is chosen as output format">
            <param type="select" name="plot_opt" label="Choose plot output extension" multiple="True" display="checkboxes" >
                <option value="PNG">PNG</option>
                <option value="JPEG">JPEG</option>
                <option value="PDF" selected="True">PDF</option>
            </param>
        </section>
    </inputs>
    <outputs>
	    <collection type="list" label="GO Profile diagram outputs" name="output" >
	        <discover_datasets pattern="(?P&lt;designation&gt;.+\.png)" ext="png" />
	        <discover_datasets pattern="(?P&lt;designation&gt;.+\.jpeg)" ext="jpg" />
	        <discover_datasets pattern="(?P&lt;designation&gt;.+\.pdf)" ext="pdf" />
	    </collection>
    </outputs>
    <tests>
        <test>
            <conditional name="input">
                <param name="ids" value="file" />
                <param name="file" value="UnipIDs.txt" />
                <param name="ncol" value="c1" />
                <param name="header" value="false" />               
            </conditional>
            <param name="onto_opt" value="CC,MF,BP" />
            <param name="level" value="2" />
            <param name="per" value="true" />
            <param name="title" value="Test" />
            <section name="opt" >
                <param name="plot_opt" value="PDF" />
            </section>
            <output_collection name="output" type="list" >
                <element name="goprofile.BP.pdf" file="goprofile.BP.pdf" ftype="pdf" />
                <element name="goprofile.MF.pdf" file="goprofile.MF.pdf" ftype="pdf" />
                <element name="goprofile.CC.pdf" file="goprofile.CC.pdf" ftype="pdf" />
            </output_collection>
        </test>
    </tests>
    <help><![CDATA[
This tool, based on the goProfiles R package, performs statistical analysis of functional profiles. It is based on GO ontology and considers either a gene set ('Entrez’ Identifiers) or a protein set (Uniprot ID) as input. 

You can choose one or more GO categories: 

* Biological Process (BP) 
* Cellular Component (CC) 
* Molecular Function (MF) 

Functional profile at a given GO level is obtained by counting the number of identifiers having a hit in each category of this level (2 by default). Results are displayed as bar plots (with absolute or relative frequencies) and can be exported in pdf, png and jpeg formats.  

For more details about GoProfiles, please read: Salicrú et al. Comparison of lists of genes based on functional profiles. BMC Bioinformatics. 2011;12:401.(https://bmcbioinformatics.biomedcentral.com/articles/10.1186/1471-2105-12-401)  

If your type of identifiers is not supported (i.e. different form Uniprot and Entrez), please use the **ID Converter** component in the ProteoRE section to convert your list of IDs first.

-----

.. class:: infomark

**Authors** 

Sanchez A, Ocana J and Salicru M (2016). goProfiles: goProfiles: an R package for the statistical analysis of functional profiles. R package version 1.38.0.

.. class:: infomark

**Galaxy integration**

T.P. Lien Nguyen, Florence Combes, Yves Vandenbrouck CEA, INSERM, CNRS, Grenoble-Alpes University, BIG Institute, FR
Sandra Dérozier, Olivier Rué, Christophe Caron, Valentin Loux INRA, Paris-Saclay University, MAIAGE Unit,Migale Bioinformatics platform,

Contact [e-mail] for any questions or concerns about the Galaxy implementation of this tool.

    ]]></help>
    <citations>
    </citations>
</tool>