annotate scanpy-normalise-data.xml @ 1:e541f264fad2 draft

"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:11:56 -0400
parents 1dda36e73482
children 059f8d2e8be1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
2 <tool id="scanpy_normalise_data" name="Scanpy NormaliseData" version="@TOOL_VERSION@+galaxy1">
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
3 <description>to make all cells having the same total expression</description>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
4 <macros>
1
e541f264fad2 "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: 0
diff changeset
5 <import>scanpy_macros2.xml</import>
0
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
6 </macros>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
7 <expand macro="requirements"/>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
9 ln -s '${input_obj_file}' input.h5 &&
1
e541f264fad2 "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: 0
diff changeset
10 PYTHONIOENCODING=utf-8 scanpy-normalise-data
e541f264fad2 "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: 0
diff changeset
11 --normalize-to ${scale_factor}
e541f264fad2 "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: 0
diff changeset
12 --fraction ${fraction}
e541f264fad2 "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: 0
diff changeset
13 --save-raw ${save_raw}
e541f264fad2 "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: 0
diff changeset
14 @INPUT_OPTS@
e541f264fad2 "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: 0
diff changeset
15 @OUTPUT_OPTS@
0
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
16 ]]></command>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
17
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
18 <inputs>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
19 <expand macro="input_object_params"/>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
20 <expand macro="output_object_params"/>
1
e541f264fad2 "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: 0
diff changeset
21 <param name="scale_factor" argument="--normalize-to" type="float" value="1e4" min="0"
e541f264fad2 "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: 0
diff changeset
22 label="Target number to normalise to" help="Aimed counts per cell after normalisation."/>
e541f264fad2 "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: 0
diff changeset
23 <param name="fraction" argument="--fraction" type="float" value="1" min="0" max="1"
e541f264fad2 "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: 0
diff changeset
24 label="Exclude top expressed genes until the remaining account for no greater than specified fraction of total counts"
e541f264fad2 "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: 0
diff changeset
25 help="Only non-excluded genes will sum up the target number."/>
e541f264fad2 "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: 0
diff changeset
26 <param name="save_raw" argument="--save-raw" type="boolean" truevalue="yes" falsevalue="no" checked="true"
e541f264fad2 "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: 0
diff changeset
27 label="Save normalised data in `.raw`" help="The saved normalised data are log1p transformed."/>
0
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
28 <expand macro="export_mtx_params"/>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
29 </inputs>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
30
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
31 <outputs>
1
e541f264fad2 "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: 0
diff changeset
32 <data name="output_h5" format="h5" from_work_dir="output.h5" label="${tool.name} on ${on_string}: Normalised data"/>
0
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
33 <expand macro="export_mtx_outputs"/>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
34 </outputs>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
35
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
36 <tests>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
37 <test>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
38 <param name="input_obj_file" value="filter_genes.h5"/>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
39 <param name="input_format" value="anndata"/>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
40 <param name="output_format" value="anndata"/>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
41 <param name="scale_factor" value="1e4"/>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
42 <param name="save_raw" value="false"/>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
43 <output name="output_h5" file="normalise_data.h5" ftype="h5" compare="sim_size"/>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
44 </test>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
45 </tests>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
46
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
47 <help><![CDATA[
1
e541f264fad2 "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: 0
diff changeset
48 =============================================================
e541f264fad2 "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: 0
diff changeset
49 Normalise total counts per cell (`scanpy.pp.normalize_total`)
e541f264fad2 "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: 0
diff changeset
50 =============================================================
0
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
51
1
e541f264fad2 "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: 0
diff changeset
52 Normalise each cell by total counts over all genes (excluding top expressed
e541f264fad2 "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: 0
diff changeset
53 genes if so required), so that every cell has the same total count after
e541f264fad2 "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: 0
diff changeset
54 normalisation.
0
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
55
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
56 Similar functions are used, for example, by Seurat, Cell Ranger or SPRING.
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
57
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
58 @HELP@
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
59
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
60 @VERSION_HISTORY@
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
61 ]]></help>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
62 <expand macro="citations"/>
1dda36e73482 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
63 </tool>