Mercurial > repos > ebi-gxa > scanpy_find_cluster

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scanpy-find-cluster.xml	Wed Apr 03 11:09:12 2019 -0400
@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="utf-8"?>
+<tool id="scanpy_find_cluster" name="Scanpy FindCluster" version="@TOOL_VERSION@+galaxy1">
+  <description>based on community detection on KNN graph</description>
+  <macros>
+    <import>scanpy_macros.xml</import>
+  </macros>
+  <expand macro="requirements"/>
+  <command detect_errors="exit_code"><![CDATA[
+ln -s '${input_obj_file}' input.h5 &&
+PYTHONIOENCODING=utf-8 scanpy-find-cluster.py
+    -i input.h5
+    -f '${input_format}'
+    -o output.h5
+    -F '${output_format}'
+    #if $output_cluster
+        --output-text-file output.tsv
+    #end if
+    #if $settings.default == "false"
+        --flavor '${settings.flavor}'
+        --key-added '${settings.key_added}'
+        -s '${settings.random_seed}'
+        #if $settings.flavor == "vtraag" and $settings.resolution_file
+            --resolution \$( cat $settings.resolution_file )
+        #elif $settings.flavor == "vtraag"
+            --resolution '${settings.resolution}'
+        #end if
+        #if $settings.restrict_to
+            --restrict-to '${settings.restrict_to}'
+        #end if
+        #if $settings.use_weights
+            --use-weights
+        #end if
+    #end if
+]]></command>
+
+  <inputs>
+    <expand macro="input_object_params"/>
+    <expand macro="output_object_params"/>
+    <param name="output_cluster" type="boolean" checked="true" label="Output cluster in two column text format"/>
+    <conditional name="settings">
+      <param name="default" type="boolean" checked="true" label="Use programme defaults"/>
+      <when value="true"/>
+      <when value="false">
+        <param name="flavor" argument="--flavor" type="select" label="Use the indicated representation">
+          <option value="vtraag" selected="true">vtraag</option>
+          <option value="igraph">igraph</option>
+        </param>
+        <param name="resolution" argument="--resolution" type="float" value="1.0" label="Resolution, high value for more and smaller clusters"/>
+        <param name="resolution_file" argument="--resolution" type="data" format="txt,tsv" optional="true" label="File with resolution, use with parameter iterator. Overrides the resolution setting"/>
+        <param name="restrict_to" argument="--restrict-to" type="text" optional="true" label="Restrict clustering to certain sample categories"/>
+        <param name="key_added" argument="--key-added" type="text" value="louvain" label="Key under which to add the cluster labels (do not change unless you know what you are doing)"/>
+        <param name="use_weights" argument="--use-weights" type="boolean" checked="false" label="Use weights from knn graph"/>
+        <param name="random_seed" argument="--random-seed" type="integer" value="0" label="Seed for random number generator"/>
+      </when>
+    </conditional>
+  </inputs>
+
+  <outputs>
+    <data name="output_h5" format="h5" from_work_dir="output.h5" label="${tool.name} on ${on_string}: Cluster object"/>
+    <data name="output_txt" format="tsv" from_work_dir="output.tsv" label="${tool.name} on ${on_string}: Cluster table">
+      <filter>output_cluster</filter>
+    </data>
+  </outputs>
+
+  <tests>
+    <test>
+      <param name="input_obj_file" value="compute_graph.h5"/>
+      <param name="input_format" value="anndata"/>
+      <param name="output_format" value="anndata"/>
+      <param name="output_txt" value="true"/>
+      <param name="default" value="false"/>
+      <param name="flavor" value="vtraag"/>
+      <param name="resolution" value="1.0"/>
+      <param name="random_seed" value="0"/>
+      <output name="output_h5" file="find_cluster.h5" ftype="h5" compare="sim_size"/>
+      <output name="output_txt" file="find_cluster.tsv" ftype="tsv"/>
+    </test>
+  </tests>
+
+  <help><![CDATA[
+===========================================
+Cluster cells into subgroups (`tl.louvain`)
+===========================================
+
+Cluster cells using the Louvain algorithm (Blondel et al, 2008) in the implementation
+of Traag et al,2017. The Louvain algorithm has been proposed for single-cell
+analysis by Levine et al, 2015.
+
+This requires to run `Scanpy ComputeGraph`, first.
+
+It yields `louvain`, generated cluster label.
+
+@HELP@
+
+@VERSION_HISTORY@
+]]></help>
+  <expand macro="citations">
+    <citation type="doi">10.1088/1742-5468/2008/10/P10008</citation>
+    <citation type="doi">10.1016/j.cell.2015.05.047</citation>
+    <citation type="doi">10.5281/zenodo.35117</citation>
+  </expand>
+</tool>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scanpy_macros.xml	Wed Apr 03 11:09:12 2019 -0400
@@ -0,0 +1,109 @@
+<macros>
+  <token name="@TOOL_VERSION@">1.3.2</token>
+  <token name="@HELP@">More information can be found at https://scanpy.readthedocs.io</token>
+  <token name="@PLOT_OPTS@">
+#if $do_plotting.plot
+                  -P output.png
+                  --projectio $do_plotting.projection
+                  --components $do_plotting.components
+    #if $do_plotting.color_by
+                  --color-by $do_plotting.color_by
+    #end if
+    #if $do_plotting.groups
+                  --group $do_plotting.groups
+    #end if
+    #if $do_plotting.use_raw
+                  --use-raw
+    #end if
+    #if $do_plotting.palette
+                  --palette $do_plotting.palette
+    #end if
+    #if $do_plotting.edges
+                  --edges
+    #end if
+    #if $do_plotting.arrows
+                  --arrows
+    #end if
+    #if not $do_plotting.sort_order
+                  --no-sort-order
+    #end if
+    #if $do_plotting.frameoff
+                  --frameoff
+    #end if
+#end if
+  </token>
+  <xml name="requirements">
+    <requirements>
+      <requirement type="package" version="0.0.5">scanpy-scripts</requirement>
+      <yield/>
+    </requirements>
+  </xml>
+  <token name="@EXPORT_MTX_OPTS@">
+      ${export_mtx}
+  </token>
+  <token name="@VERSION_HISTORY@"><![CDATA[
+**Version history**
+
+1.3.2+galaxy1: Normalise-data and filter-genes: Exposes ability to output 10x files.
+
+1.3.2+galaxy0: Initial contribution. Ni Huang and Pablo Moreno, Expression Atlas team https://www.ebi.ac.uk/gxa/home  at
+EMBL-EBI https://www.ebi.ac.uk/ and Teichmann Lab at Wellcome Sanger Institute.
+    ]]></token>
+  <xml name="citations">
+    <citations>
+      <citation type="doi">10.1186/s13059-017-1382-0</citation>
+      <citation type="bibtex">
+	@misc{githubscanpy-scripts,
+	author = {Ni Huang, EBI Gene Expression Team},
+	year = {2018},
+	title = {Scanpy-scripts: command line interface for Scanpy},
+	publisher = {GitHub},
+	journal = {GitHub repository},
+	url = {https://github.com/ebi-gene-expression-group/scanpy-scripts},
+      }</citation>
+      <yield />
+    </citations>
+  </xml>
+  <xml name="input_object_params">
+    <param name="input_obj_file" argument="--input-object-file" type="data" format="h5" label="Input object in hdf5 format"/>
+    <param name="input_format" argument="--input-format" type="select" label="Format of input object">
+      <option value="anndata" selected="true">AnnData format hdf5</option>
+      <option value="loom">Loom format hdf5, current support is incomplete</option>
+    </param>
+  </xml>
+  <xml name="output_object_params">
+    <param name="output_format" argument="--output-format" type="select" label="Format of output object">
+      <option value="anndata" selected="true">AnnData format hdf5</option>
+      <option value="loom">Loom format hdf5, current support is defective</option>
+    </param>
+  </xml>
+  <xml name="output_plot_params">
+    <param name="color_by" argument="--color-by" type="text" value="n_genes" label="Color by attributes, comma separated strings"/>
+    <param name="groups" argument="--groups" type="text" optional="ture" label="Restrict plotting to named groups, comma separated strings"/>
+    <param name="projection" argument="--projection" type="select" label="Plot projection">
+      <option value="2d" selected="true">2D</option>
+      <option value="3d">3D</option>
+    </param>
+    <param name="components" argument="--components" type="text" value="1,2" label="Components to plot, comma separated integers"/>
+    <param name="palette" argument="--palette" type="text" optional="true" label="Palette"/>
+    <param name="use_raw" argument="--use-raw" type="boolean" checked="false" label="Use raw attributes if present"/>
+    <param name="edges" argument="--edges" type="boolean" checked="false" label="Show edges"/>
+    <param name="arrows" argument="--arrows" type="boolean" checked="false" label="Show arrows"/>
+    <param name="sort_order" argument="--no-sort-order" type="boolean" checked="true" label="Element with high color-by value plot on top"/>
+    <param name="frameoff" argument="--frameoff" type="boolean" checked="false" label="Omit frame"/>
+  </xml>
+  <xml name="export_mtx_params">
+    <param name="export_mtx" argument="--export-mtx" type="boolean" truevalue="--export-mtx ./" falsevalue="" checked="false" label="Save normalised data to 10x format" help="If enabled, it will generate in addition to the main output in Loom or AnnData an export in 10x format of the normalised data."/>
+  </xml>
+  <xml name="export_mtx_outputs">
+    <data name="matrix_10x" format="txt" from_work_dir="matrix.mtx" label="${tool.name} on ${on_string}: 10x matrix">
+      <filter>export_mtx</filter>
+    </data>
+    <data name="genes_10x" format="tsv" from_work_dir="genes.tsv" label="${tool.name} on ${on_string}: 10x genes">
+      <filter>export_mtx</filter>
+    </data>
+    <data name="barcodes_10x" format="tsv" from_work_dir="barcodes.tsv" label="${tool.name} on ${on_string}: 10x barcodes">
+      <filter>export_mtx</filter>
+    </data>
+  </xml>
+</macros>