view scatterplot.xml @ 1:2e7bc1bb2dbe draft default tip

Uploaded

<tool id="scatterplot_rpy" name="Scatterplot" version="1.1.0">
  <description>of two numeric columns</description>
  <expand macro="requirements" />
    <macros>
        <import>statistic_tools_macros.xml</import>
    </macros>
    <command interpreter="python">
<![CDATA[
        scatterplot.py $input $out_file1 $col1 $col2 "$title" "$xlab" "$ylab"
]]>
    </command>
    <inputs>
        <param name="input" type="data" format="tabular" label="Dataset" help="Dataset missing? See TIP below"/>
        <param name="col1" type="data_column" data_ref="input" numerical="True" label="Numerical column for x axis" />
        <param name="col2" type="data_column" data_ref="input" numerical="True" label="Numerical column for y axis" />
        <param name="title" size="30" type="text" value="Scatterplot" label="Plot title"/>
        <param name="xlab" size="30" type="text" value="V1" label="Label for x axis"/>
        <param name="ylab" size="30" type="text" value="V2" label="Label for y axis"/>
    </inputs>
    <outputs>
        <data format="pdf" name="out_file1" />
    </outputs>
    <tests>
        <test>
            <param name="input" value="scatterplot_in1.tabular" ftype="tabular"/>
            <param name="col1" value="2"/>
            <param name="col2" value="3"/>
            <param name="title" value="Scatterplot"/>
            <param name="xlab" value="V1"/>
            <param name="ylab" value="V2"/>
            <output name="out_file1" file="scatterplot_out1.pdf" />
        </test>
  </tests>
  <help>
<![CDATA[

.. class:: infomark

**TIP:** If your data is not TAB delimited, use *Text Manipulation->Convert*

-----

**Syntax**

This tool creates a simple scatter plot between two variables containing numeric values of a selected dataset.

- All invalid, blank and comment lines in the dataset are skipped.  The number of skipped lines is displayed in the resulting history item.

- **Plot title** The scatterplot title
- **Label for x axis** and **Label for y axis** The labels for x and y axis of the scatterplot.

-----

**Example**

- Input file::

    1   68  4.1
    2   71  4.6
    3   62  3.8
    4   75  4.4
    5   58  3.2
    6   60  3.1
    7   67  3.8
    8   68  4.1
    9   71  4.3
    10  69  3.7

- Create a simple scatterplot between the variables in column 2 and column 3 of the above dataset.

.. image:: $PATH_TO_IMAGES/images/scatterplot.png

]]>
    </help>
</tool>