annotate metacyto_histogram.xml @ 0:f5526d97056c draft default tip

"planemo upload for repository https://github.com/AstraZeneca-Omics/immport-galaxy-tools/tree/master/flowtools/metacyto_histogram commit cb978232e32b64f7b0ff3c1852e708361045d268"

<tool id="metacyto_histogram" name="Generate histograms" version="1.0+galaxy0" profile="18.01">
  <description>of MetaCyto's clustering results</description>
  <requirements>
    <requirement type="package" version="1.4.0">bioconductor-metacyto</requirement>
  </requirements>
  <stdio>
    <exit_code range="1:9" />
    <exit_code range="10" level="fatal" description="Please provide a valid input FCS file." />
    <exit_code range="11" level="fatal" description="Please provide a valid input file for gate definitions." />
    <exit_code range="12" level="fatal" description="Please provide a cluster definition" />
    <exit_code range="13:" />
  </stdio>
  <command><![CDATA[
    Rscript --slave --vanilla '$__tool_directory__/metacyto_histogram.R' '${input}' '${input.name}' 'metacyto_plots' '${unused}' '${outformat}'
  #if $input_option.co == "F"
    'F' '${input_option.gates}'
  #else if $input_option.co == "L"
    'L' '${input_option.first_def}'
    #for $r in $input_option.cl_df
      '${r.cluster_def}'
    #end for
  #end if
  ]]>
  </command>
  <inputs>
    <param format="fcs" name="input" type="data" label="FCS file"/>
    <conditional name="input_option">
      <param name="co" type="select" label="Clusters to plot">
        <option value="F">from file</option>
        <option value="L">manual input</option>
      </param>
      <when value="F">
        <param format="metacyto_clr.txt" name="gates" type="data" label="List of cluster definition" help="One gate definition per line."/>
      </when>
      <when value="L">
        <param name="first_def" type="text" label="Additional cluster definition:" help="i.e.:CD3+,CD4-,CD8+,CCR7+"/>
        <repeat name="cl_df" title="Cluster:">
          <param name="cluster_def" type="text" label="Additional cluster definition:" help="i.e.:CD3+,CD4-,CD8+,CCR7+"/>
        </repeat>
      </when>
    </conditional>
    <param name="outformat" type="select" label="Output Format" help="PDF will be larger files that may take some time to load.">
      <option value="PNG" selected="true">PNG</option>
      <option value="PDF">PDF</option>
    </param>
  </inputs>
  <outputs>
    <data format="txt" name="unused" label="List of clusters not found in ${input.name}"/>
    <collection type="list" label="Histograms in ${input.name}, PNG format" name="output_png">
      <discover_datasets pattern="(?P&lt;name&gt;.*)" directory="metacyto_plots" format="png" />
      <filter>outformat=="PNG"</filter>
    </collection>
    <collection type="list" label="Histograms in ${input.name}, PDF format" name="output_pdf">
      <discover_datasets pattern="(?P&lt;name&gt;.*)" directory="metacyto_plots" format="pdf" />
      <filter>outformat=="PDF"</filter>
    </collection>
  </outputs>
  <tests>
    <test>
      <param name="input" value="Group1.fcs"/>
      <param name="co" value="L"/>
      <param name="first_def" value="CD3+,CD4-"/>
      <param name="outformat" value="PNG"/>
      <output name="unused">
        <assert_contents>
          <has_n_lines n="1"/>
        </assert_contents>
      </output>
      <output_collection name="output_png">
        <element name="Group1_CD3+CD4-_plot.png" ftype="png">
          <assert_contents>
            <has_size value="105600" delta="30000"/>
          </assert_contents>
        </element>
      </output_collection>
    </test>
  </tests>
  <help><![CDATA[
Histograms of the distribution of events after clustering with MetaCyto for provided gating definitions
-------------------------------------------------------------------------------------------------------

**Input files**

This tool requires a valid FCS file and a list of clusters as input.

**Output**

This tool generates plots to show the distribution of cells in each cluster definition. The gray histograms show the distribution of markers in all cells. The red histograms show the distribution of markers in the identified cell subset.

**Example**

*Input* - Cluster List::

   Marker1+|Marker3-
   Marker1+|Marker2+|Marker3-
   ...

*Output* - Unused Cluster List::

   Marker1+|Marker3-
   Marker1-|Marker2+|Marker3-
   ...

*Graphical output*

.. image:: images/meta_histo.png
  ]]>
  </help>
</tool>