annotate scpred_predict.xml @ 7:b869bb6d4b01 draft default tip

"planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
author ebi-gxa
date Fri, 27 Nov 2020 13:46:06 +0000
parents eca76dd511f4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
eca76dd511f4 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit bb88d0eb9c193518eb0d05321e3458a10212d3ab"
ebi-gxa
parents: 4
diff changeset
1 <tool id="scpred_predict_labels" name="Scpred predict" version="@TOOL_VERSION@+galaxy0">
0
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
2 <description>Make cell type predictions using trained model.</description>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
3 <macros>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
4 <import>scpred_macros.xml</import>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
5 </macros>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
6 <expand macro="requirements" />
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
7
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
8 scpred_predict.R --input-object "${input_object}" --pred-data "${pred_data}" --normalise-data "${normalise_data}" --recompute-alignment "${recompute_alignment}" --reference-scaling "${reference_scaling}" --output-path "${output_path}"
2
051f5801c819 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 59503a4ae6f53a7782336df4f82fbd755cfb2933"
ebi-gxa
parents: 0
diff changeset
9
7
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
10 #if $normalisation_method
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
11 --normalisation-method "${normalisation_method}"
2
051f5801c819 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 59503a4ae6f53a7782336df4f82fbd755cfb2933"
ebi-gxa
parents: 0
diff changeset
12 #end if
7
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
13 #if $scale_factor
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
14 --scale-factor "${scale_factor}"
2
051f5801c819 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 59503a4ae6f53a7782336df4f82fbd755cfb2933"
ebi-gxa
parents: 0
diff changeset
15 #end if
7
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
16 #if $threshold_level
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
17 --threshold-level "${threshold_level}"
2
051f5801c819 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 59503a4ae6f53a7782336df4f82fbd755cfb2933"
ebi-gxa
parents: 0
diff changeset
18 #end if
7
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
19 #if $max_iter_harmony
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
20 --max-iter-harmony "${max_iter_harmony}"
2
051f5801c819 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 59503a4ae6f53a7782336df4f82fbd755cfb2933"
ebi-gxa
parents: 0
diff changeset
21 #end if
051f5801c819 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 59503a4ae6f53a7782336df4f82fbd755cfb2933"
ebi-gxa
parents: 0
diff changeset
22
0
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
23 ]]></command>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
24 <inputs>
7
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
25
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
26 <param type="data" name="input_object" label="Input Seurat Object" format="rdata" help="Input Seurat object in .rds format" />
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
27 <param type="data" name="pred_data" label="Query Data Matrix" format="rdata" help="Path to the input prediction matrix in .rds format"/>
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
28 <param type="boolean" checked="false" name="normalise_data" label="Normalise Data" help="Should the predicted expression data be normalised? Default: False"/>
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
29 <param type="text" name="normalisation_method" optional="true" value="LogNormalize" label="Normalisation Method" help="What normalisation method should be applied to predicted data? Default: LogNormalize" />
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
30 <param type="integer" name="scale_factor" optional="true" value="1000000" label="Scale Factor" help="What scale factor should be applied? Note: for CPM normalisation, 1e6 is selected by default" />
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
31 <param type="float" name="threshold_level" optional="true" value="0.8" label="Threshold Level" help="Classification threshold value" />
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
32 <param type="integer" name="max_iter_harmony" optional="true" value="20" label="Max Iterations" help="Maximum number of rounds to run Harmony. One round of Harmony involves one clustering and one correction step" />
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
33 <param type="boolean" checked="true" name="recompute_alignment" label="Recompute Alignment" help="Recompute alignment? Useful if scPredict() has already been run. Default: True"/>
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
34 <param type="boolean" checked="true" name="reference_scaling" label="Reference Scaling" help="Scale new dataset based on means and stdevs from reference dataset before alignment. Default: True"/>
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
35
0
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
36 </inputs>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
37 <outputs>
7
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
38 <data name="output_path" format="rdata" />
0
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
39 </outputs>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
40 <tests>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
41 <test>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
42 <param name="input_object" value="scPred_trained.rds" />
7
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
43 <param name="normalise_data" value="True" />
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
44 <param name="pred_data" value="query_pbmc.rds" />
b869bb6d4b01 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 5
diff changeset
45 <output name="output_path" file="predicted_data.rds" compare="sim_size" delta="10000000"/>
0
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
46 </test>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
47 </tests>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
48 <help><![CDATA[
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
49 @HELP@
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
50
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
51 @VERSION_HISTORY@
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
52 ]]></help>
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
53 <expand macro="citations" />
c54f0e1a3bd8 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 6ea13bbd7294b94201a5d776307b3f0742847db1"
ebi-gxa
parents:
diff changeset
54 </tool>