annotate seurat_normalise_data.xml @ 3:87de4824cb32 draft default tip

planemo upload commit 34c30124158749b9eef51d5f323b608a503e7940
author ebi-gxa
date Sun, 01 Oct 2023 09:07:32 +0000
parents ce141a4e433e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
87de4824cb32 planemo upload commit 34c30124158749b9eef51d5f323b608a503e7940
ebi-gxa
parents: 2
diff changeset
1 <tool id="seurat_normalise_data" name="Seurat NormaliseData" profile="18.01" version="@SEURAT_VERSION@+galaxy0">
0
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
2 <description>normalise data</description>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
3 <macros>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
4 <import>seurat_macros.xml</import>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
5 </macros>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
6 <expand macro="requirements" />
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
7 <expand macro="version" />
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
9 seurat-normalise-data.R
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
10
2
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
11 @INPUT_OBJECT@
0
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
12 #if $norm:
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
13 --normalization-method $norm
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
14 #end if
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
15 #if $assay:
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
16 --assay-type '$assay'
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
17 #end if
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
18 #if $scale:
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
19 --scale-factor $scale
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
20 #end if
2
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
21 @OUTPUT_OBJECT@
0
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
22 ]]></command>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
23
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
24 <inputs>
2
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
25 <expand macro="input_object_params"/>
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
26 <expand macro="output_object_params"/>
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
27 <param name="norm" argument="--normalization-method" type="select" optional="True" label="Normalisation method" help = "Method for normalization. Default is log-normalization (LogNormalize). Can be 'CLR' or 'RC' additionally.">
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
28 <option value="LogNormalize" selected="true">Log Normalise</option>
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
29 <option value="CLR">CLR</option>
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
30 <option value="RC">RC</option>
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
31 </param>
0
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
32 <param name="assay" argument="--assay-type" type="text" optional="True" label="Assay type" help = "Type of assay to normalize for (default is RNA), but can be changed for multimodal analyses.">
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
33 <validator type="regex" message="Please only use letters">^[\(\w\)]+$</validator>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
34 </param>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
35 <param name="scale" argument="--scale-factor" type="integer" optional="True" label="Scale factor" help="Sets the scale factor for cell-level normalization"/>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
36 </inputs>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
37
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
38 <outputs>
2
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
39 <expand macro="output_files"/>
0
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
40 </outputs>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
41
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
42 <tests>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
43 <test>
3
87de4824cb32 planemo upload commit 34c30124158749b9eef51d5f323b608a503e7940
ebi-gxa
parents: 2
diff changeset
44 <param name="rds_seurat_file" ftype="rdata" value="E-MTAB-6077-3k_features_90_cells.rds"/>
87de4824cb32 planemo upload commit 34c30124158749b9eef51d5f323b608a503e7940
ebi-gxa
parents: 2
diff changeset
45 <output name="rds_seurat_file" ftype="rdata">
87de4824cb32 planemo upload commit 34c30124158749b9eef51d5f323b608a503e7940
ebi-gxa
parents: 2
diff changeset
46 <assert_contents>
87de4824cb32 planemo upload commit 34c30124158749b9eef51d5f323b608a503e7940
ebi-gxa
parents: 2
diff changeset
47 <has_size value="2720178" delta="200000"/>
87de4824cb32 planemo upload commit 34c30124158749b9eef51d5f323b608a503e7940
ebi-gxa
parents: 2
diff changeset
48 </assert_contents>
87de4824cb32 planemo upload commit 34c30124158749b9eef51d5f323b608a503e7940
ebi-gxa
parents: 2
diff changeset
49 </output>
0
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
50 </test>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
51 </tests>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
52 <help><![CDATA[
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
53 .. class:: infomark
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
54
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
55 **What it does**
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
56
2
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
57 This tool normalises a Seurat RDS object.
0
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
58
2
ce141a4e433e "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 3fc448754d6720855f781caa7938e33d3961b092"
ebi-gxa
parents: 1
diff changeset
59 @SEURAT_INTRO@
0
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
60
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
61 -----
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
62
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
63 **Inputs**
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
64
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
65 * Seurat RDS object. Possibly the output of Seurat filter cells or Seurat create object.
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
66 * Normalisation method. Method for normalization. Default is log-normalization (LogNormalize).
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
67 * Assay type. Type of assay to normalize for (default is RNA), but can be changed for multimodal analyses.
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
68 * Scale factor. Sets the scale factor for cell-level normalization. Default: 1000
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
69
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
70 -----
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
71
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
72 **Outputs**
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
73
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
74 * Seurat RDS object with normalised matrix.
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
75
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
76 .. _Seurat: https://www.nature.com/articles/nbt.4096
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
77 .. _Satija Lab: https://satijalab.org/seurat/
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
78
1
fe2f888644e6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents: 0
diff changeset
79 @VERSION_HISTORY@
0
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
80 ]]></help>
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
81 <expand macro="citations" />
51639924cd38 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit fc12e1e90bdc675bd81cf50528afd64ff3dc5c08
ebi-gxa
parents:
diff changeset
82 </tool>