annotate abims_CAMERA_annotateDiffreport.xml @ 3:729991209550 draft

Uploaded

<tool id="abims_CAMERA_annotateDiffreport" name="CAMERA.annotate" version="2.1.0">

    <description>CAMERA annotate function. Returns annotation results (isotope peaks, adducts and fragments) and a diffreport if more than one condition.</description>
    
    <requirements>
        <requirement type="package" version="3.1.2">R</requirement>
        <requirement type="binary">Rscript</requirement>
        <requirement type="package" version="1.44.0">xcms</requirement>
        <requirement type="package" version="1.22.0">camera</requirement>
        <requirement type="package" version="2.1">camera_w4m_script</requirement>
    </requirements>
    
    <stdio>
        <exit_code range="1:" level="fatal" />
    </stdio>

    <command interpreter="Rscript">
        CAMERA.r 
        xfunction annotatediff image $image
        convert_param $convert_param num_digits $num_digits nSlaves \${GALAXY_SLOTS:-1}
        sigma $sigma perfwhm $perfwhm 
        maxcharge $maxcharge maxiso $maxiso minfrac $minfrac
        ppm $ppm mzabs $mzabs intval $intval 
        max_peaks $max_peaks
        quick $quick_block.quick
        #if $quick_block.quick == "FALSE"
            polarity $quick_block.polarity
            cor_eic_th $quick_block.cor_eic_th
            graphMethod $quick_block.graphMethod 
            pval $quick_block.pval 
            calcCiS $quick_block.calcCiS
            calcIso $quick_block.calcIso
            calcCaS $quick_block.calcCaS
            multiplier $quick_block.multiplier
        #end if

        #if $options.option == "show":
            eicmax $options.eicmax
            eicwidth $options.eicwidth
            value $options.value
            sortpval $options.sortpval 
            h $options.h
            w $options.w
            mzdec $options.mzdec
        #else
            eicmax 0
            eicwidth 200
            value "into"
            sortpval TRUE 
            h 480
            w 640
            mzdec 2
        #end if
        &amp;&amp; (
            mv variableMetadata.tsv $variableMetadata;
            mv dataMatrix.tsv $datamatrix;
            mv annotatediff.RData $rdata
        );
        cat xset.log
        
      
    </command>

    <inputs>
    
    
        <param name="image" type="data" label="RData file" format="rdata.xcms.fillpeaks,rdata" help="output file from another function xcms (fillPeaks)" />

        <param name="convert_param" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="Convert retention time (seconds) into minutes" help="Convert the columns rtmed, rtmin and rtmax into minutes"/>
        <param name="num_digits" type="integer" value="0" label="" help="Number of decimal places for mass values reported in ions identifiers" />

        <param name="sigma" type="integer" value="6" label="groupFWHM: multiplier of the standard deviation" help="[sigma]" />
        <param name="perfwhm" type="float" value="0.6" max="1" min="0" label="groupFWHM: percentage of FWHM width" help="[perfwhm]" />
        <param name="maxcharge" type="integer" value="3" label="findIsotopes: max. ion charge" help="[maxcharge]" />
        <param name="maxiso" type="integer" value="4" label="findIsotopes: max. number of expected isotopes" help="[maxiso]" />
        <param name="minfrac" type="float" value="0.5" max="1" min="0" label="findIsotopes: The percentage number of samples, which must satisfy the C12/C13 rule for isotope annotation" help="[minfrac]" />
        <param name="ppm" type="integer" value="5" label="General ppm error" help="[ppm]" />
        <param name="mzabs" type="float" value="0.015" label="mzabs" help="General absolut error in m/z" />
        <param name="intval" type="select" label="General used intensity value" help="[intval] See the help section below">
            <option value="into" selected="true">into</option>
            <option value="maxo" >maxo</option>
            <option value="intb">intb</option>
        </param> 
    

        <param name="max_peaks" type="integer" value="100" label="How much peaks will be calculated in every thread using the parallel mode" help="[max_peaks]" />
        <conditional name="quick_block">
            <param name="quick" type="select" label="Quick mode" help="[quick] If TRUE, use only groupFWHM and findIsotopes functions. Else if FALSE, use also groupCorr and findAdducts">
                <option value="TRUE">TRUE</option>
                <option value="FALSE" selected="true">FALSE</option>
            </param>
            <when value="FALSE">
                <param name="polarity" type="select" label="findAdducts: Which polarity mode was used for measuring of the ms sample" help="polarity">
                    <option value="positive" >positive</option>
                    <option value="negative" selected="true">negative</option>
                </param>		
                <param name="cor_eic_th" type="float" value="0.75" max="1" min="0" label="groupCorr: correlation threshold (0..1)" help="[cor_eic_th]" />
                <param name="graphMethod" type="select" label="groupCorr: Method selection for grouping peaks after correlation analysis into pseudospectra" help="[graphMethod]">
                    <option value="hcs" selected="true">hcs</option>
                    <option value="lpc">lpc</option>
                </param>
                <param name="pval" type="float" value="0.05" max="1" min="0" label="groupCorr: significant correlation threshold" help="[pval]" />
                <param name="calcCiS" type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="groupCorr: Use correlation inside samples for peak grouping" help="[calcCiS]"/>
                <param name="calcIso" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="groupCorr: Use isotopic relationship for peak grouping" help="[calcIso]"/>
                <param name="calcCaS" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="groupCorr: Use correlation across samples for peak grouping" help="[calcCaS]"/>
                <param name="multiplier" type="integer" value="3" label="findAdducts: If no ruleset is provided, calculate ruleset with max. number n of [nM+x] clusterions" help="[multiplier]" />
            </when>	
                <when value="TRUE">
                <param name="polarity" type="hidden" value="quick" label="for the output label" help="for the output label" />
            </when>	
        </conditional>
                           
    
        <!-- Annotatediffreport specific parameters -->
        <conditional name="options">
            <param name="option" type="select" label="Number of condition">
                <option value="hide" selected="true">One condition</option>
                <option value="show">Two or more conditions</option>  
            </param>
            <when value="show">
                <param name="eicmax" type="integer" value="0" label="diffreport: number of the most significantly different analytes to create EICs for" help="[eicmax]" />
                <param name="eicwidth" type="integer" value="200" label="diffreport: width (in seconds) of EICs produced" help="[eicwidth]" />
                <param name="value" type="select" label="diffreport: Intensity values to be used for the diffreport" help="[value]">
                    <option value="into" selected="true">into</option>
                    <option value="maxo" >maxo</option>
                    <option value="intb">intb</option>
                </param> 
                <param name="h" type="integer" value="480" label="diffreport: Numeric variable for the height of the eic and boxplots that are printed out" help="[height]" /> 
                <param name="w" type="integer" value="640" label="diffreport: Numeric variable for the width of the eic and boxplots print out made" help="[width]" />
                <param name="mzdec" type="integer" value="2" label="diffreport: Number of decimal places of title m/z values in the eic plot" help="[mzdec]" />
                <param name="sortpval" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="diffreport: logical indicating whether the reports should be sorted by p-value" help="[sortpval]"/>
            </when>
            <when value="hide">
            </when>
        </conditional>
       
    </inputs>

    <outputs>
        <data name="variableMetadata" format="tabular" label="${image.name[:-6]}.annotate.variableMetadata.tsv" />
        <data name="datamatrix" format="tabular" label="${image.name[:-6]}.annotate.dataMatrix.tsv" />
        <data name="rdata" format="rdata.camera.quick" label="${image.name[:-6]}.annotate.${$quick_block.polarity}.Rdata" >
            <change_format>
                <when input="quick_block.polarity" value="positive" format="rdata.camera.positive" />
                <when input="quick_block.polarity" value="negative" format="rdata.camera.negative" />
            </change_format>
        </data>
	<data name="output_zip" format="zip" from_work_dir="Xdiffreport.zip" label="${image.name[:-6]}.annotateDiffreport.zip" >
		 <filter>(options['option'] == 'show')</filter>
	</data>    
    </outputs>
    
    <tests>
        <test>
            <param name="image" value="xset.group.retcor.group.fillPeaks.RData"/>
            <param name="convert_param" value="False"/>
            <param name="num_digits" value="0"/>
            <param name="sigma" value="6"/>
            <param name="perfwhm" value="0.6"/>
            <param name="maxcharge" value="3"/>
            <param name="maxiso" value="4"/>
            <param name="minfrac" value="0.5"/>
            <param name="ppm" value="5"/>
            <param name="mzabs" value="0.015"/>
            <param name="intval" value="into"/>
            <param name="max_peaks" value="100"/>
            <param name="quick_block.quick" value="FALSE"/>
            <param name="quick_block.polarity" value="negative"/>
            <param name="quick_block.cor_eic_th" value="0.75"/>
            <param name="quick_block.graphMethod" value="hcs"/>
            <param name="quick_block.pval" value="0.05"/>
            <param name="quick_block.calcCiS" value="True"/>
            <param name="quick_block.calcIso" value="False"/>
            <param name="quick_block.calcCaS" value="False"/>
            <param name="quick_block.multiplier" value="3"/>
            <param name="options.option" value="show"/>
            <param name="options.eicmax" value="200"/>
            <param name="options.eicwidth" value="200"/>
            <param name="options.value" value="into"/>
            <param name="options.h" value="480"/>
            <param name="options.w" value="640"/>
            <param name="options.mzdec" value="2"/>
            <param name="options.sortpval" value="False"/>
            <output name="variableMetadata" file="xset.group.retcor.group.fillPeaks.annotate.variableMetadata.tsv" />
            <output name="datamatrix" file="xset.group.retcor.group.fillPeaks.annotate.dataMatrix.tsv" />
            <output name="rdata" file="xset.group.retcor.group.fillPeaks.annotate.negative.Rdata" />
        </test>
    </tests>
    
    
    
    <help>
        
.. class:: infomark

**Authors** Carsten Kuhl [e-mail], Ralf Tautenhahn [e-mail], Steffen Neumann sneumann@@ipb-halle.de

.. class:: infomark

**Galaxy integration** ABiMS TEAM - UPMC/CNRS - Station biologique de Roscoff and Yann Guitton [e-mail] - part of Workflow4Metabolomics.org [W4M]

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

---------------------------------------------------


================
CAMERA.annotate
================

-----------
Description
-----------

The R-package CAMERA is a Collection of Algorithms for MEtabolite
pRofile Annotation. Its primary purpose is the annotation and evaluation of
LC-MS data. It includes algorithms for annotation of isotope peaks, adducts
and fragments in peak lists. Additional methods cluster mass signals that
originate from a single metabolite, based on rules for mass differences and
peak shape comparison. To use the strength of already existing programs,
CAMERA is designed to interact directly with processed peak data from the
R-package **xcms**.

**What it does?**

The CAMERA annotation procedure can be split into two parts: We want to answer the questions which peaks occur from the same molecule and secondly compute its exact mass and annotate the ion species. Therefore CAMERA annotation workflow contains following primary functions: 1. peak grouping after retention time (**groupFWHM**) 2. peak group verification with peakshape correlation (**groupCorr**) Both methods separate peaks into different groups, which we define as ”pseu- dospectra”. Those pseudospectra can consists from one up to 100 ions, de- pending on the molecules amount and ionizability. Afterwards the exposure of the ion species can be performed with: 2 1. annotation of possible isotopes (**findIsotopes**) 2. annotation of adducts and calculating hypothetical masses for the group (**findAdducts**) This workflow results in a data-frame similar to a xcms peak table, that can be easily stored in a comma separated table .csv (Excel-readable). 

If you have two or more conditions, it will return a diffreport result within the annotation results.
The diffreport result shows the most significant differences between two sets of samples. Optionally
create extracted ion chromatograms for the most significant differences.


-----------------
Workflow position
-----------------


**Upstream tools**

========================= ==================== ====================== ==========
Name                      output file          format                 parameter
========================= ==================== ====================== ==========
xcms.fillPeaks            xset.fillPeaks.RData rdata.xcms.fillpeaks   RData file
========================= ==================== ====================== ==========


**Downstream tools**

+---------------------------+---------------------------------------+------------------------------------------------+
| Name                      | Output file                           | Format                                         |
+===========================+=======================================+================================================+
|CAMERA_combinexsAnnot      |xset.annotate.dataMatrix.tsv           | rdata.camera.positive or rdata.camera.negative |
+---------------------------+---------------------------------------+------------------------------------------------+
|Determine Vdk or Lowess    |xset.annotate.dataMatrix.tsv           | Tabular                                        |
+---------------------------+---------------------------------------+------------------------------------------------+
|Normalization Vdk/Lowess   |xset.annotate.dataMatrix.tsv           | Tabular                                        |
+---------------------------+---------------------------------------+------------------------------------------------+
|Anova                      |xset.annotate.dataMatrix.tsv           | Tabular                                        |
+---------------------------+---------------------------------------+------------------------------------------------+
|PCA                        |xset.annotate.dataMatrix.tsv           | Tabular                                        |
+---------------------------+---------------------------------------+------------------------------------------------+
|Hierarchical Clustering    |xset.annotate.dataMatrix.tsv           | Tabular                                        |
+---------------------------+---------------------------------------+------------------------------------------------+


The output file **xset.annotate.dataMatrix.tsv** is an tabular file. You can continue your analysis using it in the following tools:

    | Determine Vdk or Lowess
    | Normalization Vdk/Lowess
    | Anova
    | PCA
    | Hierarchical Clustering


**General schema of the metabolomic workflow**

.. image:: annotate_workflow.png

-----------
Input files
-----------

+---------------------------+---------------------------+
| Parameter : num + label   |   Format                  |
+===========================+===========================+
| 1 : RData file            |   rdata.xcms.fillpeaks    |
+---------------------------+---------------------------+


----------
Parameters
----------

diffreport: Intensity values to be used for the diffreport
----------------------------------------------------------

    | If **value="into"**, integrated peak intensities are used.
    | If **value="maxo"**, maximum peak intensities are used.
    | If **value="intb"**, baseline corrected integrated peak intensities are used (only available if peak detection was done by ‘findPeaks.centWave’).



------------
Output files
------------

xset.annotate.variableMetadata.tsv

    | For each metabolite (row) :
    | the value of the intensity in each sample, fold, anova, mzmed, mzmin, mzmax, rtmed, rtmin, rtmax, npeaks, isotopes, adduct and pcgroup

xset.annotate.dataMatrix.tsv

    | A tabular file which represents for each metabolite (row), the value of the intensity in each sample (column).
    
xset.annotate.zip

    | It contains filebase_eic, filebase_box and filebase.tsv for one conditon vs another (Anova analysis).

xset.annotate.Rdata rdata.camera.quick or rdata.camera.positive or rdata.camera.negative

    | Rdata file, that be used outside Galaxy in R.
    
------

.. class:: infomark 

The output **"xset.annotate.dataMatrix.tsv"** is a tabular file. You can continue your analysis using it in the following tools of the workflow:

    | Determine Vdk or Lowess (Data correction)
    | Normalization Vdk/Lowess (Data correction)
    | Anova (Statistical analysis)
    | PCA (Statistical analysis)
    | Hierarchical Clustering (Statistical analysis)

    
---------------------------------------------------

---------------
Working example
---------------

Input files
-----------

    | RData file -> **xset.fillPeaks.RData**

Parameters
----------

    | sortpval -> **false**
    | sigma -> **6 (default)**
    | perfwhm -> **0.6 (default)**
    | maxcharge -> **3 (default)**
    | maxiso -> **4 (default)**
    | minfrac -> **0.5 (default)**
    | ppm -> **500**
    | mzabs -> **0.015(default)**
    | Advanced options -> **hide**
    | Numver of condition -> Two or more conditioons
    | eicmax -> **200**
    | eicwidth -> **200 (default)**

    

Output files
------------

**Example of an xset.annotate.dataMatrix.tsv output**

.. image:: annotatediffreport_dataMatrix.png

**Example of a part of xset.annotate.variableMetadata.tsv output** 

.. image:: annotatediffreport_variableMetadata.png

    </help>

    <citations>
        <citation type="doi">10.1021/ac202450g</citation>
        <citation type="doi">10.1093/bioinformatics/btu813</citation>
    </citations>


</tool>