annotate center_scale.xml @ 2:163befe5f05b draft default tip

planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/main/tools/gsc_center_scale commit 41ba5435a8ad12c1fe0703a9ce44b759003f3f73

<tool id="center_scale" name="Center or scale (standardize) data" version="4.3.1+galaxy0" profile="21.01">
    <description></description>
    <requirements>
        <requirement type="package" version="1.7.3">r-optparse</requirement>
    </requirements>
    <stdio>
        <exit_code range="1:" level="fatal" description="Tool exception" />
    </stdio>
    <command detect_errors="exit_code"><![CDATA[ 
        Rscript $__tool_directory__/center_scale.R 
            --data '$input'
            --center '$center'
            --scale '$scale'
            #if $factor.factor_options == 'TRUE':
               --factor '$file'
            #end if
            --output '$output'
]]></command>
    <inputs>
        <param name="input" type="data" format="tabular" label="Input file with values to transform"
               help="Must be tabular separated with columns and row names, variables in rows, observations in columns" />
        <param name="center" type="select" label="Center data to mean">
            <option value="TRUE" selected="true">Yes</option>
            <option value="FALSE">No</option>
        </param>
        <param name="scale" type="select" label="Scale data to standard deviation">
            <option value="TRUE" selected="true">Yes</option>
            <option value="FALSE">No</option>
        </param>
        <conditional name="factor">
            <param name="factor_options" type="select" label="group data by factor ?">
                <option value="TRUE">Yes</option>
                <option value="FALSE" selected="true">No</option>
            </param>
            <when value="TRUE">
                <param name="file" type="data" format="tabular" label="Grouping map"
                       help="A two-column observation|factor_level table that assigns group ids to observations" /> 
            </when>
            <when value="FALSE">
            </when>
        </conditional>
    </inputs>
    <outputs>
        <data name="output" format="tabular" label="scale ${on_string}" />
    </outputs>
    <tests>
        <test>
            <param name="input" value="fulldata.tsv" ftype="tabular"/>
            <param name="scale" value="TRUE"/>
            <param name="center" value="TRUE"/>
            <output name="output" file="full_standardize.tab" ftype="tabular"/>
        </test>
        <test>
            <param name="input" value="fulldata.tsv" ftype="tabular"/>
            <param name="scale" value="FALSE"/>
            <param name="center" value="TRUE"/>
            <output name="output" file="full_center.tab" ftype="tabular"/>
        </test>
        <test>
            <param name="input" value="fulldata.tsv" ftype="tabular"/>
            <param name="scale" value="TRUE"/>
            <param name="center" value="FALSE"/>
            <output name="output" file="full_scale.tab" ftype="tabular"/>
        </test>
        <test>
            <param name="input" value="fulldata.tsv" ftype="tabular" />
            <param name="scale" value="TRUE"/>
            <param name="center" value="TRUE"/>
            <param name="factor_options" value="TRUE" />
            <param name="file" value="fulldata.map.tsv" ftype="tabular" />          
            <output name="output" file="group_standardize.tab" ftype="tabular"/>
        </test>
        <test>
            <param name="input" value="fulldata.tsv" ftype="tabular" />
            <param name="scale" value="FALSE"/>
            <param name="center" value="TRUE"/>
            <param name="factor_options" value="TRUE" />
            <param name="file" value="fulldata.map.tsv" ftype="tabular" />          
            <output name="output" file="group_center.tab" ftype="tabular"/>
        </test>
        <test>
            <param name="input" value="fulldata.tsv" ftype="tabular" />
            <param name="scale" value="TRUE"/>
            <param name="center" value="FALSE"/>
            <param name="factor_options" value="TRUE" />
            <param name="file" value="fulldata.map.tsv" ftype="tabular" />          
            <output name="output" file="group_scale.tab" ftype="tabular"/>
        </test>
    </tests>
    <help>

**What it does**

The tool perform various normalization operations on a data table, including mean centering,
standard deviation rescaling, or both (standardization).

In addition, these operations can be performed on subsets of observations, if the user provides
a two-column table that maps observations to groups (factor levels).

**Inputs**

A data table with observations (samples, library sequencings) in columns (library names
are column names) and variables (genes) in rows (gene names are row names).

Optionally, a two-column table may be used to map observations to a factor level. In this
case, normalization operations will be performed by group having same level.

**Outputs**

A table with same numbers of columns and rows as input table, and transformed values.

    </help>
    <citations>
        <citation type="bibtex">
        @Manual{,
             title = {R: A Language and Environment for Statistical Computing},
             author = {{R Core Team}},
             organization = {R Foundation for Statistical Computing},
             address = {Vienna, Austria},
             year = {2014},
             url = {http://www.R-project.org/},
        }
        </citation>
    </citations>
</tool>