view macros.xml @ 2:5147f08d67c9 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/Tracegroomer commit 26f0c7344995bfa302db821e77ae717636a4f4b2

<macros>
    <token name="@TOOL_VERSION@">0.1.4</token>
    <token name="@VERSION_SUFFIX@">1</token>
    <xml name="requirements">
        <requirements>
            <requirement type="package" version="@TOOL_VERSION@">tracegroomer</requirement>
        </requirements>
    </xml>
    <xml name="input_datasets">
        <param name="labeled_metabo_file" type="data" optional="false" format="tabular,xlsx" label="Labeled metabolomics file"/>
        <param name="sample_metadata_path" type="data" format="tabular" label="sample metadata file" help="The metadata, a unique file with the description of the samples in your measures files. This is compulsory, see section Metadata File Information."/>
        <param name="amount_material" type="data" optional="true" format="interval" label="amount material" help="Absolute path to the file having the amount of material by sample, for the normalization. This file must be a tab delimited file with exactly 2 columns with a header: the first column contains the original names of the samples, and the second column the numbers (tissue weight, number of cells, volume, etc)"/>
        <param name="remove_these_metabolites" type="data" optional="true" format="interval" label="remove metabolites using this file" help="Absolute path to the tab delimited file with columns: compartment, metabolite. This file lists the metabolites to be completely excluded, compartment specific. Defining such exclusion list requires deep knowledge of the data by the user (measurements coherence/quality, etc)"/>
        <conditional name="type_of_file">
            <param name="type_of_file_selector" type="select" label="Choose which type of input file is used" help="One of the following: IsoCor_out_tsv|rule_tsv|VIBMEC_xlsx|generic_xlsx">
                    <option value="IsoCor_out_tsv" selected="true">isocor output file</option>
                    <option value="VIBMEC_xlsx">VIBMEC xlsx file</option>
                    <option value="generic_xlsx">generic xlsx file</option>
                    <option value="rule_tsv">rule tsv file</option>
            </param>
            <when value="IsoCor_out_tsv">
            </when>
            <when value="generic_xlsx">
                <param name="sheetname" type="text" value="isotopologuesCorrValues" optional="false" label="name of the sheet containing the isotopologues corrected values" >
                        <sanitizer invalid_char="">
                            <valid initial="string.ascii_letters,string.digits">
                                <add value="_" />
                            </valid>
                        </sanitizer>
                    </param>
            </when>
            <when value="VIBMEC_xlsx">
                <param name="raw_abundance_sheet_name" type="text" value="rawAbundances" optional="false" label="name of the sheet containing the raw abundances values" >
                        <sanitizer invalid_char="">
                            <valid initial="string.ascii_letters,string.digits">
                                <add value="_" />
                            </valid>
                        </sanitizer>
                </param>
                <param name="frac_contribution_sheet_name" type="text" value="FracContribution_C" optional="false" label="name of the sheet containing the mean enrichment  values" >
                        <sanitizer invalid_char="">
                            <valid initial="string.ascii_letters,string.digits">
                                <add value="_" />
                            </valid>
                        </sanitizer>
                </param>
                <param name="corrected_isotopologues_sheet_name" type="text" value="CorrectedIsotopologues" optional="false" label="name of the sheet containing the isotopologues corrected values" >
                        <sanitizer invalid_char="">
                            <valid initial="string.ascii_letters,string.digits">
                                <add value="_" />
                            </valid>
                        </sanitizer>
                </param>
            </when>
            <when value="rule_tsv">
                <param name="variable_metadata_path" type="data" format="tabular" label="variable metadata file" help="The metadata, a unique file with the description of the samples in your measures files. This is compulsory, see section Metadata File Information."/>
                <section name="columns_variable_metadata_description" title="variable metadata file columns description" expanded="false">
                    <param name="identifier" type="text" value="ID" optional="false" label="identifier of your metabolite in variable metadata file" >
                        <sanitizer invalid_char="">
                            <valid initial="string.ascii_letters,string.digits">
                                <add value="_" />
                            </valid>
                        </sanitizer>
                    </param>
                    <param name="compound" type="text" value="metabolite_name" optional="false" label="name of your metabolite in variable metadata file (formula is also accepted)" >
                        <sanitizer invalid_char="">
                            <valid initial="string.ascii_letters,string.digits">
                                <add value="_" />
                            </valid>
                        </sanitizer>
                    </param>
                    <param name="isotopologue_number" value="isotope_numeric" type="text" optional="false" label="isotopologue number in variable metadata file" >
                        <sanitizer invalid_char="">
                            <valid initial="string.ascii_letters,string.digits">
                                <add value="_" />
                            </valid>
                        </sanitizer>
                    </param>
                </section>
            </when>
        </conditional>
    </xml>
    <xml name="advanced_options">
        <section name="advanced_options" title="Advanced options" expanded="false" help="Default values explained in our Wiki page (link at the end of the Help section)">
            <param name="div_isotopologues_by_amount_material" type="boolean" truevalue="--div_isotopologues_by_amount_material" checked="true" falsevalue="--no-div_isotopologues_by_amount_material" label="isotopologues division by amount material" help="Apply normalization by the amount of material at the level of isotopologue absolute values. Immediately after this, and before any other computation, tracegroomer re-computes all derived (thus normalized) metrics"/>
            <param name="alternative_div_amount_material" type="boolean"  truevalue="--alternative_div_amount_material" checked="true" falsevalue="--no-alternative_div_amount_material" label="alternative division of values by amount material" help="In the normalisation by the amount of material, not only the division of the given absolute values by these amounts is performed, but also the product of the resulting quotients 'q' and the averaged amount of material 'a' (q x a) so abundance units are preserved"/>
            <param name="isotopologues_preview" type="boolean" truevalue="--isotopologues_preview" checked="false" falsevalue="--no-isotopologues_preview" label="Plot isotopologues" help="Generate simple plots that give a general overview of the isotopologue proportions given by the user. Performs a scatter plot of the individual isotopologue proportions for all metabolites, as well as a plot of the sums of isotopologue proportions (the sum must be equal to 1 for each metabolite and sample)"/>
            <param name="fractions_stomp_values" type="boolean" truevalue="--fractions_stomp_values" checked="true" falsevalue="--no-fractions_stomp_values" label="Stomp fractional contributions" help="Stomps fractional contributions (synonym: mean enrichment), and isotopologue proportions, to max 1.0 and min 0.0"/>
            <param name="subtract_blankavg" type="boolean" truevalue="--subtract_blankavg" checked="true" falsevalue="--no-subtract_blankavg" label="Subtract blanks avg (VIB input only)" help="from samples' abundances, subtracts the average of the blanks for all metabolites across all samples. Note that the Internal Standards are not subjected to this operation, as recommended by VIB platform"/>
            <param name="under_detection_limit_set_nan" type="boolean" truevalue="--under_detection_limit_set_nan" checked="true" falsevalue="--no-under_detection_limit_set_nan" label="Limit Of Detection (VIB input only)" help="The Limit Of Detection, LOD, corresponds to the averaged blanks abundance values, multiplied by three times the blanks standard deviation. By default, any value that is strictly inferior to its corresponding LOD, is converted into NaN"/>
            <param name="use_internal_standard" type="text" optional="true" help="The name of the internal standard, which is a compound or metabolite that has been stated as reference signal. By providing this name, the normalization by the internal standard is automatically performed" label="internal standard" />
            <param name="isosprop_min_admitted" type="float" min="-1.0" max="1.0" value="-0.5" label="isotopologues cutoff" help="Metabolites whose isotopologue proportions are less or equal to this cutoff, are removed"/>
            <param name="output_files_extension" type="select" value="tsv" display="radio" label="output files extension" help="Note that tab delimited files are always produced, for any chosen extension">
                <option value="tsv">tsv</option>
                <option value="csv">csv</option>
            </param>
        </section>
    </xml>
    <xml name="citations">
        <citations>
            <citation type="doi">10.1093/bioinformatics/btae282</citation>
            <citation type="bibtex">
                @software{Galvis_Rodriguez_DIMet,
                    author = {Galvis Rodriguez, Johanna  and Guyon, Joris and Dartigues, Benjamin and Specque, Florian and Daubon, Thomas and Karkar, Slim and Nikolski, Macha},
                    license = {MIT},
                    title = {{DIMet}},
                    url = {https://github.com/cbib/DIMet}
                    }
            </citation>
        </citations>

    </xml>
</macros>