annotate seurat_export_cellbrowser.xml @ 1:80eec773c961 draft

planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f

<tool id="seurat_export_cellbrowser" name="Seurat Export2CellBrowser" version="@SEURAT_VERSION@_@VERSION@+galaxy0">
    <description>produces files for UCSC CellBrowser import.</description>
    <macros>
        <import>seurat_macros.xml</import>
    </macros>
    <expand macro="requirements" />
    <expand macro="version" />
    <command detect_errors="exit_code"><![CDATA[
#if $markers_file:
  cp '$markers_file' markers.csv;
#end if

seurat-export-cellbrowser.R
@INPUT_OBJECT@

#if $markers_file:
-m markers.csv
#end if

-o output_html;

cd output_html && tar -cf '$output' *;
]]></command>

    <inputs>
        <expand macro="input_object_params"/>
        <param name="markers_file" type="data" format="txt" label="Marker genes file from Seurat" />
    </inputs>

    <outputs>
        <data name="output" format="tar" label="${tool.name} on ${on_string}: UCSC CellBrowser bundle"/>
    </outputs>

    <tests>
        <test>
            <param name="rds_input" ftype="rdata" value="out_runtsne.rds"/>
            <param name="markers_file" ftype="txt" value="out_markers.csv"/>
            <output name="output" ftype="tar" value="out_cellbrowser_bundle.tar"/>
        </test>
    </tests>
    <help><![CDATA[
.. class:: infomark

**What it does**

This tool converts a Seurat object (hopefully with t-SNE results) and its
accompanying marker genes file (optional) to a tar that can be feed to the
UCSC CellBrowser tool.

@SEURAT_INTRO@

-----

**Inputs**

    * RDS object

-----

**Outputs**

    * Text file

.. _Seurat: https://www.nature.com/articles/nbt.4096
.. _Satija Lab: https://satijalab.org/seurat/

@VERSION_HISTORY@

]]></help>
      <expand macro="citations" />
</tool>