annotate scanpy-scale-data.xml @ 0:eae21a6c3128 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
author ebi-gxa
date Wed, 13 Mar 2019 11:50:13 -0400
parents
children edb0d2e8ab66
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
2 <tool id="scanpy_scale_data" name="Scanpy ScaleData" version="@TOOL_VERSION@+galaxy1">
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
3 <description>to make expression variance the same for all genes</description>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
4 <macros>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
5 <import>scanpy_macros.xml</import>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
6 </macros>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
7 <expand macro="requirements"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
9 ln -s '${input_obj_file}' input.h5 &&
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
10 PYTHONIOENCODING=utf-8 scanpy-scale-data.py
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
11 -i input.h5
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
12 -f '${input_format}'
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
13 -o output.h5
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
14 -F '${output_format}'
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
15 #if $scale_max
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
16 -x '${scale_max}'
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
17 #end if
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
18 #if $var_to_regress
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
19 -V '${var_to_regress}'
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
20 #end if
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
21 #if $do_log
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
22 --do-log
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
23 #end if
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
24 #if $zero_center
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
25 --zero-center
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
26 #end if
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
27 ]]></command>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
28
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
29 <inputs>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
30 <expand macro="input_object_params"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
31 <expand macro="output_object_params"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
32 <param name="do_log" argument="--do-log" type="boolean" checked="true" label="Do log(x+1) transformation"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
33 <param name="zero_center" argument="--zero-center" type="boolean" checked="true" label="Zero center data before scaling"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
34 <param name="var_to_regress" argument="--var-to-regress" type="text" optional="true" label="Variable(s) to regress out">
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
35 <option value="n_counts">n_counts</option>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
36 </param>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
37 <param name="scale_max" argument="--scale-max" type="float" optional="true" label="Truncate to this value after scaling"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
38 </inputs>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
39
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
40 <outputs>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
41 <data name="output_h5" format="h5" from_work_dir="output.h5" label="${tool.name} on ${on_string}: Scaled data"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
42 </outputs>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
43
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
44 <tests>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
45 <test>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
46 <param name="input_obj_file" value="find_variable_genes.h5"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
47 <param name="input_format" value="anndata"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
48 <param name="output_format" value="anndata"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
49 <param name="do_log" value="true"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
50 <param name="zero_center" value="true"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
51 <param name="scale_max" value="10"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
52 <output name="output_h5" file="scale_data.h5" ftype="h5" compare="sim_size"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
53 </test>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
54 </tests>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
55
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
56 <help><![CDATA[
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
57 .. class:: infomark
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
58
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
59 **What it does**
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
60
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
61 Scale data to unit variance and zero mean (`pp.scale`)
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
62 Regress out unwanted sources of variation (`pp.regress_out`)
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
63
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
64 Regress out unwanted sources of variation, using simple linear regression. This is
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
65 inspired by Seurat's `regressOut` function in R.
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
66
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
67 @HELP@
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
68
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
69 @VERSION_HISTORY@
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
70 ]]></help>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
71 <expand macro="citations"/>
eae21a6c3128 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy-scripts commit dca9be719ceb86abad7589c240b1bb7656826c48-dirty
ebi-gxa
parents:
diff changeset
72 </tool>