annotate scanpy-regress-variable.xml @ 24:2cf10c8c094d draft

"planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9ea121884e1aecd2ee66a0686057cb3ed904b9eb-dirty"
author ebi-gxa
date Thu, 28 Oct 2021 10:00:24 +0000
parents 59d3ce1cfaa8
children 1200b55768ce
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
12
e277d77dc6da "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 62f47287c7e8449c59a1f1f454852ddc669b1b1e-dirty"
ebi-gxa
parents: 9
diff changeset
2 <tool id="scanpy_regress_variable" name="Scanpy RegressOut" version="@TOOL_VERSION@+galaxy0" profile="@PROFILE@">
0
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
3 <description>variables that might introduce batch effect</description>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
4 <macros>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
5 <import>scanpy_macros2.xml</import>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
6 </macros>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
7 <expand macro="requirements"/>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
1
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
9 #if $variable_keys
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
10 ln -s '${input_obj_file}' input.h5 &&
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
11 PYTHONIOENCODING=utf-8 scanpy-regress
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
12 --keys '${variable_keys}'
19
59d3ce1cfaa8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit ebe77c8718ec65277f4dc0d71fa5f4c5677df62d-dirty"
ebi-gxa
parents: 13
diff changeset
13 @SAVE_MATRIX_OPTS@
1
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
14 @INPUT_OPTS@
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
15 @OUTPUT_OPTS@
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
16 #else
13
8205e95227e4 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9028e8fa3761fd640dcace5d36bf9b7d558319f7-dirty"
ebi-gxa
parents: 12
diff changeset
17 echo "No regression variables passed, simply passing original input as output unchanged." && cp '${input_obj_file}' output.h5
1
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
18 #end if
0
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
19 ]]></command>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
20
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
21 <inputs>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
22 <expand macro="input_object_params"/>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
23 <expand macro="output_object_params"/>
1
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
24 <param name="variable_keys" type="text" label="Variables to regress out" help="Use comma to separate multiple variables. Not supplying variables will simply pass the input data as output unchanged.">
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
25 <sanitizer>
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
26 <valid initial="string.printable"/>
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
27 </sanitizer>
203fac3b1ba3 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 1cc5d2101b8b14fa99e11b01714e5544704e669f
ebi-gxa
parents: 0
diff changeset
28 </param>
19
59d3ce1cfaa8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit ebe77c8718ec65277f4dc0d71fa5f4c5677df62d-dirty"
ebi-gxa
parents: 13
diff changeset
29 <expand macro="save_matrix_params"/>
0
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
30 </inputs>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
31
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
32 <outputs>
5
b174cb4cb89e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 400799f99ee36ad12b990b1ccabf4be16a26c003
ebi-gxa
parents: 1
diff changeset
33 <expand macro="output_data_obj" description="Regressed out ${variable_keys}"/>
0
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
34 </outputs>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
35
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
36 <tests>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
37 <test>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
38 <param name="input_obj_file" value="find_variable_genes.h5"/>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
39 <param name="input_format" value="anndata"/>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
40 <param name="output_format" value="anndata"/>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
41 <param name="variable_keys" value="n_counts"/>
12
e277d77dc6da "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 62f47287c7e8449c59a1f1f454852ddc669b1b1e-dirty"
ebi-gxa
parents: 9
diff changeset
42 <output name="output_h5" file="regress.h5" ftype="h5" compare="sim_size"/>
0
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
43 </test>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
44 </tests>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
45
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
46 <help><![CDATA[
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
47 .. class:: infomark
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
48
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
49 **What it does**
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
50
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
51 Regress out unwanted source of variance (`scanpy.pp.regress_out`)
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
52
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
53 @HELP@
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
54
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
55 @VERSION_HISTORY@
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
56 ]]></help>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
57 <expand macro="citations"/>
6c990f8ccad3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 4846776f55931e176f7e77af7c185ec6fec7d142"
ebi-gxa
parents:
diff changeset
58 </tool>