annotate scmap_scmap_cell.xml @ 13:48400c291093 draft

planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
author ebi-gxa
date Tue, 23 Apr 2024 07:48:26 +0000
parents 65b719530dd5
children 32ae4a600167
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11
1543a50e08c9 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit bb88d0eb9c193518eb0d05321e3458a10212d3ab"
ebi-gxa
parents: 10
diff changeset
1 <tool id="scmap_scmap_cell" name="Scmap cell projection" version="@TOOL_VERSION@+galaxy1" profile="@PROFILE@">
0
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
2 <description>searches each cell in a query dataset for the nearest neighbours by cosine distance within a collection of reference datasets.</description>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
3 <macros>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
4 <import>scmap_macros.xml</import>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
5 </macros>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
6 <expand macro="requirements" />
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
8 scmap-scmap-cell.R
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
9 -i '$index_single_cell_experiment'
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
10 -p '$project_single_cell_experiment'
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
11 --number-nearest-neighbours '$n_nearest_neighbours'
13
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
12 --nearest-neighbours-threshold '$nearest_neighbours_threshold'
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
13 --threshold '$threshold'
0
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
14 --cluster-col '${cluster_projection.cluster_col}'
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
15 --output-object-file '$output_single_cell_experiment'
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
16 --closest-cells-text-file '$closest_cells_text_file'
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
17 --closest-cells-similarities-text-file '$closest_cells_similarities_text_file'
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
18 #if $cluster_projection
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
19 --output-clusters-text-file '$closest_cells_clusters_csv'
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
20 #end if
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
21 ]]></command>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
22 <inputs>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
23 <param type="data" name="index_single_cell_experiment" label="Index SingleCellExperiment object" format="rdata" help="File with serialized SingleCellExperiment object as produced by 'scmap select features' and 'scmap index clusters', onto which another dataset will be projected." />
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
24 <param type="data" name="project_single_cell_experiment" label="SingleCellExperiment object to project" format="rdata" help="File with serialized SingleCellExperiment object to project onto the index'" />
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
25 <param name="n_nearest_neighbours" type="integer" label="Number of nearest neighbours" value='5' help="A positive integer specifying the number of nearest neighbours to find" />
13
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
26 <param name="nearest_neighbours_threshold" type="integer" label="Nearest neighbour threshold" value='3' help="A positive integer specifying the number of matching nearest neighbours required to label a cell." />
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
27 <param name="threshold" type="integer" label="Similarity threshold" value='0.7' help="Threshold on similarity (or probability for SVM and RF)." />
0
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
28 <conditional name="cluster_projection">
7
5e6d54e2ab89 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 87e6fbd3764e43b31eaa9baf9df5692eb83c8fdc"
ebi-gxa
parents: 4
diff changeset
29 <param name="do_cluster_projection" type="boolean" checked="false" label="Annotate cells of the projection dataset using labels of the reference?" help="If cell cluster annotation is available for the reference datasets, in addition to finding top 10 nearest neighbours scmap-cell also allows to annotate cells of the projection dataset using labels of the reference."/>
0
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
30 <when value="true" >
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
31 <param name="cluster_col" type="text" label="Cluster column" value="cell_type1" help="Column name in the 'colData' slot of the SingleCellExperiment object containing the cell classification information." />
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
32 </when>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
33 <when value="false" >
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
34 <param name="cluster_col" type="hidden" value="NULL" />
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
35 </when>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
36 </conditional>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
37 </inputs>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
38 <outputs>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
39 <data name="output_single_cell_experiment" format="rdata" />
11
1543a50e08c9 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit bb88d0eb9c193518eb0d05321e3458a10212d3ab"
ebi-gxa
parents: 10
diff changeset
40 <data name="closest_cells_text_file" format="tabular" />
1543a50e08c9 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit bb88d0eb9c193518eb0d05321e3458a10212d3ab"
ebi-gxa
parents: 10
diff changeset
41 <data name="closest_cells_similarities_text_file" format="tabular" />
1543a50e08c9 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit bb88d0eb9c193518eb0d05321e3458a10212d3ab"
ebi-gxa
parents: 10
diff changeset
42 <data name="closest_cells_clusters_csv" format="tabular">
9
b78cdc83a479 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 53f809e83bf7784787f78f16dc78d7601231dcfa"
ebi-gxa
parents: 8
diff changeset
43 <filter>cluster_projection['do_cluster_projection']</filter>
0
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
44 </data>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
45 </outputs>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
46 <tests>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
47 <test>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
48 <param name="index_single_cell_experiment" value="index_cell.rds" ftype="rdata"/>
12
65b719530dd5 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 11
diff changeset
49 <param name="project_single_cell_experiment" value="test_sce_processed.rds" ftype="rdata"/>
13
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
50 <conditional name="cluster_projection">
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
51 <param name="do_cluster_projection" value="true" />
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
52 <param name="cluster_col" value="cell_type1" />
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
53 </conditional>
2
2b85cec412c3 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 542b6e6848acedbbedb6fa2d4b44c8d476597cdd"
ebi-gxa
parents: 0
diff changeset
54 <output name="output_single_cell_experiment" file="closest_cells_clusters.rds" compare="sim_size"/>
12
65b719530dd5 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 11
diff changeset
55 <output name="closest_cells_clusters_csv" file="closest_cells_clusters.tsv" compare="sim_size" />
65b719530dd5 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 11
diff changeset
56 <output name="closest_cells_text_file" file="closest_cells.tsv" compare="sim_size"/>
65b719530dd5 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 11
diff changeset
57 <output name="closest_cells_similarities_text_file" file="closest_cells_similarities.tsv" compare="sim_size"/>
0
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
58 </test>
13
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
59 <test>
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
60 <param name="index_single_cell_experiment" value="index_cell.rds" ftype="rdata"/>
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
61 <param name="project_single_cell_experiment" value="test_sce_processed.rds" ftype="rdata"/>
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
62 <conditional name="cluster_projection">
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
63 <param name="do_cluster_projection" value="true" />
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
64 <param name="cluster_col" value="cell_type1" />
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
65 </conditional>
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
66 <param name="nearest_neighbours_threshold" value="3" />
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
67 <param name="threshold" value="0.5" />
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
68 <output name="output_single_cell_experiment" file="closest_cells_clusters_copy.rds" compare="sim_size"/>
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
69 <output name="closest_cells_clusters_csv" file="closest_cells_clusters_copy.tsv" compare="sim_size" />
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
70 <output name="closest_cells_text_file" file="closest_cells_copy.tsv" compare="sim_size"/>
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
71 <output name="closest_cells_similarities_text_file" file="closest_cells_similarities_copy.tsv" compare="sim_size"/>
48400c291093 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 8350493268ce3ced12b1133b9b0f734a288deb75
ebi-gxa
parents: 12
diff changeset
72 </test>
0
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
73 </tests>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
74 <help><![CDATA[
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
75 @HELP@
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
76
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
77 @VERSION_HISTORY@
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
78 ]]></help>
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
79 <expand macro="citations" />
cb6b70d45519 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
80 </tool>