Mercurial > repos > ebi-gxa > scanpy_scale_data
changeset 0:96b851e96dd0 draft
planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
author | ebi-gxa |
---|---|
date | Wed, 03 Apr 2019 11:09:38 -0400 |
parents | |
children | 9acb5f068e6b |
files | scanpy-scale-data.xml scanpy_macros.xml |
diffstat | 2 files changed, 181 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/scanpy-scale-data.xml Wed Apr 03 11:09:38 2019 -0400 @@ -0,0 +1,72 @@ +<?xml version="1.0" encoding="utf-8"?> +<tool id="scanpy_scale_data" name="Scanpy ScaleData" version="@TOOL_VERSION@+galaxy1"> + <description>to make expression variance the same for all genes</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-scale-data.py + -i input.h5 + -f '${input_format}' + -o output.h5 + -F '${output_format}' + #if $scale_max + -x '${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 +]]></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"/> + </inputs> + + <outputs> + <data name="output_h5" format="h5" from_work_dir="output.h5" label="${tool.name} on ${on_string}: Scaled data"/> + </outputs> + + <tests> + <test> + <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"/> + </test> + </tests> + + <help><![CDATA[ + .. class:: infomark + + **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. + + @HELP@ + + @VERSION_HISTORY@ +]]></help> + <expand macro="citations"/> +</tool>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/scanpy_macros.xml Wed Apr 03 11:09:38 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>