Mercurial > repos > ebi-gxa > scanpy_scale_data

changeset 1:9acb5f068e6b draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
author ebi-gxa
date Mon, 16 Sep 2019 08:14:52 -0400
parents 96b851e96dd0
children 3a0d4bebabc5
files scanpy-scale-data.xml scanpy_macros2.xml
diffstat 2 files changed, 105 insertions(+), 29 deletions(-) [+]
line wrap: on
line diff
--- a/scanpy-scale-data.xml	Wed Apr 03 11:09:38 2019 -0400
+++ b/scanpy-scale-data.xml	Mon Sep 16 08:14:52 2019 -0400
@@ -1,40 +1,27 @@
 <?xml version="1.0" encoding="utf-8"?>
-<tool id="scanpy_scale_data" name="Scanpy ScaleData" version="@TOOL_VERSION@+galaxy1">
+<tool id="scanpy_scale_data" name="Scanpy ScaleData" version="@TOOL_VERSION@+galaxy0">
   <description>to make expression variance the same for all genes</description>
   <macros>
-    <import>scanpy_macros.xml</import>
+    <import>scanpy_macros2.xml</import>
   </macros>
   <expand macro="requirements"/>
   <command detect_errors="exit_code"><![CDATA[
 ln -s '${input_obj_file}' input.h5 &&
-PYTHONIOENCODING=utf-8 scanpy-scale-data.py
-    -i input.h5
-    -f '${input_format}'
-    -o output.h5
-    -F '${output_format}'
+PYTHONIOENCODING=utf-8 scanpy-scale-data
     #if $scale_max
-        -x '${scale_max}'
+        --max-value '${scale_max}'
     #end if
-    #if $var_to_regress
-        -V '${var_to_regress}'
-    #end if
-    #if $do_log
-        --do-log
-    #end if
-    #if $zero_center
-        --zero-center
-    #end if
+    ${zero_center}
+    @INPUT_OPTS@
+    @OUTPUT_OPTS@
 ]]></command>
 
   <inputs>
     <expand macro="input_object_params"/>
     <expand macro="output_object_params"/>
-    <param name="do_log" argument="--do-log" type="boolean" checked="true" label="Do log(x+1) transformation"/>
-    <param name="zero_center" argument="--zero-center" type="boolean" checked="true" label="Zero center data before scaling"/>
-    <param name="var_to_regress" argument="--var-to-regress" type="text" optional="true" label="Variable(s) to regress out">
-      <option value="n_counts">n_counts</option>
-    </param>
-    <param name="scale_max" argument="--scale-max" type="float" optional="true" label="Truncate to this value after scaling"/>
+    <param name="zero_center" type="boolean" checked="true" truevalue="" falsevalue="--no-zero-center"
+           label="Zero center data before scaling"/>
+    <param name="scale_max" argument="--max-value" type="float" min="0" optional="true" label="Truncate to this value after scaling"/>
   </inputs>
 
   <outputs>
@@ -46,7 +33,6 @@
       <param name="input_obj_file" value="find_variable_genes.h5"/>
       <param name="input_format" value="anndata"/>
       <param name="output_format" value="anndata"/>
-      <param name="do_log" value="true"/>
       <param name="zero_center" value="true"/>
       <param name="scale_max" value="10"/>
       <output name="output_h5" file="scale_data.h5" ftype="h5" compare="sim_size"/>
@@ -58,11 +44,7 @@
 
     **What it does**
 
-    Scale data to unit variance and zero mean (`pp.scale`)
-    Regress out unwanted sources of variation (`pp.regress_out`)
-
-    Regress out unwanted sources of variation, using simple linear regression. This is
-    inspired by Seurat's `regressOut` function in R.
+    Scale data to unit variance and (optionally) zero mean (`scanpy.pp.scale`)
 
     @HELP@
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scanpy_macros2.xml	Mon Sep 16 08:14:52 2019 -0400
@@ -0,0 +1,94 @@
+<macros>
+  <token name="@TOOL_VERSION@">1.4.2</token>
+  <token name="@HELP@">More information can be found at https://scanpy.readthedocs.io</token>
+  <token name="@VERSION_HISTORY@"><![CDATA[
+**Version history**
+
+1.4.2+galaxy0: Update to scanpy-scripts 0.2.4 (requires scanpy >=1.4.2).
+
+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>
+  <token name="@INPUT_OPTS@">
+    --input-format '${input_format}' input.h5
+  </token>
+  <token name="@OUTPUT_OPTS@">
+    --show-obj stdout --output-format '${output_format}' output.h5
+  </token>
+  <token name="@PLOT_OPTS@">
+#if $fig_title
+    --title '${fig_title}'
+#end if
+    --fig-size '${fig_size}'
+    --fig-dpi ${fig_dpi}
+    --fig-fontsize ${fig_fontsize}
+    ${fig_frame}
+    ./output.png
+  </token>
+  <token name="@EXPORT_MTX_OPTS@">${export_mtx}</token>
+
+  <xml name="requirements">
+    <requirements>
+      <requirement type="package" version="0.2.4.post4">scanpy-scripts</requirement>
+      <yield/>
+    </requirements>
+  </xml>
+
+  <xml name="citations">
+    <citations>
+      <yield />
+      <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>
+    </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</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</option>
+    </param>
+  </xml>
+
+  <xml name="output_plot_params">
+    <param name="fig_title" argument="--title" type="text" label="Figure title"/>
+    <param name="fig_size" argument="--fig-size" type="text" value="4,4" label="Figure size as 'width,height', e.g, '7,7'"/>
+    <param name="fig_dpi" argument="--fig-dpi" type="integer" min="1" value="80" label="Figure dpi"/>
+    <param name="fig_fontsize" argument="--fig-fontsize" type="integer" min="0" value="10" label="Figure font size"/>
+    <param name="fig_frame" type="boolean" truevalue="--frameon" falsevalue="--frameoff" checked="false"
+           label="Show plot 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 mtx 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>