annotate scanpy-plot-embedding.xml @ 2:882f4671d686 draft

planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/tree/develop/tools/tertiary-analysis/scanpy commit d13a0a5fceabe51e1a6fe763767b963623aa295a
author ebi-gxa
date Mon, 28 Oct 2019 05:26:00 -0400
parents c63bc0b71865
children b2410da4e381
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c63bc0b71865 "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"?>
c63bc0b71865 "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
2 <tool id="scanpy_plot_embed" name="Scanpy PlotEmbed" version="@TOOL_VERSION@+galaxy0">
c63bc0b71865 "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>visualise cell embeddings</description>
c63bc0b71865 "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>
c63bc0b71865 "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>
c63bc0b71865 "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>
c63bc0b71865 "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"/>
c63bc0b71865 "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[
c63bc0b71865 "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
9 ln -s '${input_obj_file}' input.h5 &&
c63bc0b71865 "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
10 PYTHONIOENCODING=utf-8 scanpy-cli plot embed
c63bc0b71865 "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
11 @INPUT_OPTS@
c63bc0b71865 "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
12 --basis '${basis}'
c63bc0b71865 "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
13 --color '${color_by}'
c63bc0b71865 "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
14 ${use_raw}
c63bc0b71865 "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
15 --legend-loc '${legend_loc}'
c63bc0b71865 "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
16 --legend-fontsize '${legend_fontsize}'
c63bc0b71865 "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
17 #if $point_size
c63bc0b71865 "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
18 --size ${point_size}
c63bc0b71865 "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 #end if
c63bc0b71865 "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 @PLOT_OPTS@
c63bc0b71865 "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 ]]></command>
c63bc0b71865 "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
c63bc0b71865 "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 <inputs>
c63bc0b71865 "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
24 <expand macro="input_object_params"/>
c63bc0b71865 "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
25 <param name="basis" argument="--basis" type="text" label="Name of the embedding to plot"/>
c63bc0b71865 "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
26 <param name="color_by" argument="--color" type="text" label="Color by attributes, comma separated texts"/>
c63bc0b71865 "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
27 <param name="use_raw" argument="--use-raw" type="boolean" checked="true" truevalue="--use-raw" falsevalue="--no-raw" label="Use raw attributes if present"/>
c63bc0b71865 "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
28 <param name="legend_loc" argument="--legend-loc" type="select" label="Location of legend">
c63bc0b71865 "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
29 <option value="right margin" selected="true">Right margin</option>
c63bc0b71865 "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 <option value="on data">On data</option>
c63bc0b71865 "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 </param>
c63bc0b71865 "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 <param name="legend_fontsize" argument="--legend-fontsize" type="integer" value="15" label="Legend font size"/>
c63bc0b71865 "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
33 <param name="point_size" argument="--size" type="integer" optional="true" label="Point size"
c63bc0b71865 "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 help="Automatically determined if not specified."/>
c63bc0b71865 "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 <expand macro="output_plot_params"/>
c63bc0b71865 "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 </inputs>
c63bc0b71865 "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
c63bc0b71865 "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 <outputs>
c63bc0b71865 "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 <data name="output_png" format="png" from_work_dir="output.png" label="${tool.name} on ${on_string}: embedding plot"/>
c63bc0b71865 "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 </outputs>
c63bc0b71865 "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
c63bc0b71865 "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
42 <tests>
c63bc0b71865 "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>
c63bc0b71865 "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 <param name="input_obj_file" value="find_cluster.h5"/>
c63bc0b71865 "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 <param name="input_format" value="anndata"/>
c63bc0b71865 "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 <param name="color_by" value="louvain"/>
c63bc0b71865 "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 <output name="output_png" file="run_tsne.png" ftype="png" compare="sim_size"/>
c63bc0b71865 "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 </test>
c63bc0b71865 "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 </tests>
c63bc0b71865 "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
c63bc0b71865 "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 <help><![CDATA[
c63bc0b71865 "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 =============================================================
c63bc0b71865 "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 Plot embeddings of a given method of dimensionality reduction
c63bc0b71865 "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 =============================================================
c63bc0b71865 "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
c63bc0b71865 "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 It yields a scatter plot in png format, wherein cells are placed in space of
c63bc0b71865 "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 reduced dimensionality and coloured by attribute of choice.
c63bc0b71865 "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
c63bc0b71865 "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
59 Requires calculating the specified embeddings first. For example, to make
c63bc0b71865 "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
60 UMAP/TSNE plots, run `Scanpy RunUMAP`/`Scanpy RunTSNE` first, then enter
c63bc0b71865 "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
61 "umap"/"tsne" as the name of the embedding to plot here.
c63bc0b71865 "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
62
c63bc0b71865 "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
63 @HELP@
c63bc0b71865 "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
64
c63bc0b71865 "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
65 @VERSION_HISTORY@
c63bc0b71865 "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
66 ]]></help>
c63bc0b71865 "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
67 <expand macro="citations"/>
c63bc0b71865 "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
68 </tool>