Mercurial > repos > ebi-gxa > scanpy_normalise_data

annotate scanpy-normalise-data.xml @ 9:3636ec97f3af 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 cbe12e02ee9ff5692be7547bdbe28fd1cd013a92
author ebi-gxa
date Thu, 20 Feb 2020 10:15:59 -0500
parents 4a6b3778fcc4
children a97c37e0309a
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"?>
9
3636ec97f3af planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit cbe12e02ee9ff5692be7547bdbe28fd1cd013a92
ebi-gxa
parents: 8
diff changeset
2 <tool id="scanpy_normalise_data" name="Scanpy NormaliseData" version="@TOOL_VERSION@+galaxy9" profile="@PROFILE@">
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
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}
2
059f8d2e8be1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit ccd9b839849600b1aa3b6cf54f667575a5f2da9d
ebi-gxa
parents: 1
diff changeset
14 ${log_transform}
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
15 @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
16 @OUTPUT_OPTS@
3
378ea34bbf2a planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit d13a0a5fceabe51e1a6fe763767b963623aa295a
ebi-gxa
parents: 2
diff changeset
17 @EXPORT_MTX_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
18 ]]></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
19
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 <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
21 <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
22 <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
23 <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
24 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
25 <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
26 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
27 help="Only non-excluded genes will sum up the target number."/>
6
9e42d8795385 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: 4
diff changeset
28 <param name="log_transform" argument="--no-log-transform" type="boolean" truevalue="" falsevalue="--no-log-transform" checked="True"
2
059f8d2e8be1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit ccd9b839849600b1aa3b6cf54f667575a5f2da9d
ebi-gxa
parents: 1
diff changeset
29 label="Apply log transform?" help="If enabled, will apply a log transformation following normalisation."/>
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
30 <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
31 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
32 <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
33 </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
34
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 <outputs>
6
9e42d8795385 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: 4
diff changeset
36 <expand macro="output_data_obj" description="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
37 <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
38 </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
39
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 <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
41 <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
42 <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
43 <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
44 <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
45 <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
46 <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
47 <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
48 </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
49 </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
50
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 <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
52 =============================================================
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 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
54 =============================================================
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
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
56 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
57 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
58 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
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 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
61
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 @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
63
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
64 @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
65 ]]></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
66 <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
67 </tool>