annotate seurat_scale_data.xml @ 5:d2f6eac0ad42 draft

"planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 355bb52d2e9d170b1db237e649657cc14e0a047a"
author ebi-gxa
date Fri, 04 Mar 2022 07:27:57 +0000
parents 4147dc085d45
children 5e9ba303f9e1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
d2f6eac0ad42 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 355bb52d2e9d170b1db237e649657cc14e0a047a"
ebi-gxa
parents: 4
diff changeset
1 <tool id="seurat_scale_data" name="Seurat ScaleData" profile="18.01" version="@SEURAT_VERSION@+galaxy0">
0
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
2 <description>scale and center genes</description>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
3 <macros>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
4 <import>seurat_macros.xml</import>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
5 </macros>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
6 <expand macro="requirements" />
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
7 <expand macro="version" />
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
9 seurat-scale-data.R
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
10
1
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
11 @INPUT_OBJECT@
0
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
12 #if $vars:
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
13 --vars-to-regress '$vars'
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
14 #else
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
15 --vars-to-regress nUMI
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
16 #end if
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
17
1
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
18 #if $genes_use:
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
19 --genes-use '$genes_use'
0
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
20 #end if
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
21
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
22 --model-use '$model'
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
23
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
24 $use_umi
1
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
25 $do_not_center
0
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
26
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
27 #if $scale_max:
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
28 --scale-max '$scale_max'
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
29 #end if
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
30
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
31 #if $block_size:
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
32 --block-size '$block_size'
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
33 #end if
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
34
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
35 #if $min_cells_to_block:
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
36 --min-cells-to-block '$min_cells_to_block'
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
37 #end if
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
38
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
39 $check_for_norm
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
40
1
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
41 @OUTPUT_OBJECT@
0
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
42 ]]></command>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
43
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
44 <inputs>
1
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
45 <expand macro="input_object_params"/>
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
46 <expand macro="output_object_params"/>
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
47 <expand macro="genes-use-input"/>
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
48 <param name="vars" argument="--vars-to-regress" type='text' value="nCount_RNA" label="Vars to regress" help="Comma-separated list of variables to regress out (previously latent.vars in RegressOut). For example, nCount_RNA, or percent.mito.">
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
49 <validator type="regex" message="Please only use letters or numbers">^[\(\w\)]+$</validator>
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
50 <option value="nCount_RNA">nCount_RNA</option>
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
51 <option value="nFeature_RNA">nFeature_RNA</option>
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
52 </param>
0
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
53 <param name="model" argument="--model-use" type="select" label="Statistical model" help="Use a linear model or generalized linear model (poisson, negative binomial) for the regression.">
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
54 <option value="linear" selected="true">Linear model</option>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
55 <option value="poisson">Poisson model</option>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
56 <option value="negbinom">Negative binomial model</option>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
57 </param>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
58 <param name="use_umi" argument="--use-umi" type="boolean" truevalue="--use-umi TRUE" falsevalue="" checked="false" label="Use UMIs." help="Regress on UMI count data. Default is FALSE for linear modeling, but automatically set to TRUE if model.use is 'negbinom' or 'poisson'."/>
1
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
59 <param name="do_not_center" argument="--do-not-center" type="boolean" falsevalue="" truevalue="--do-not-center" checked="false" label="Skip centering" help="By default data is centered, with this option you can skip centering."/>
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
60 <param name="do_not_scale" argument="--do-not-scale" type="boolean" falsevalue="" truevalue="--do-not-scale" checked="false" label="Skip scaling" help="By default data is scaled, with this option you can skip scaling."/>
0
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
61 <param name="scale_max" argument="--scale-max" optional="true" type="float" label="Scale maximum" help = "Max value to return for scaled data. The default is 10. Setting this can help reduce the effects of genes that are only expressed in a very small number of cells. If regressing out latent variables and using a non-linear model, the default is 50."/>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
62 <param name="block_size" argument="--block-size" optional="true" type="integer" label="Block size" help = "Default size for number of genes to scale at in a single computation. Increasing block.size may speed up calculations but at an additional memory cost. Defaults to 1000 if not specified."/>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
63 <param name="min_cells_to_block" argument="--min-cells-to-block" optional="true" type="integer" label="Minimum number of cells to block" help="If object contains fewer than this number of cells, don't block for scaling calculations. Defaults to 1000."/>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
64 <param name="check_for_norm" argument="--check-for-norm" optional="true" type="boolean" falsevalue="--check-for-norm FALSE" truevalue="" label="Check that data is normalized" help="Check to see if data has been normalized, if not, output a warning (TRUE by default). Data can be normalised by Seurat normalise module."/>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
65 </inputs>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
66
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
67 <outputs>
1
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
68 <expand macro="output_files"/>
0
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
69 </outputs>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
70
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
71 <tests>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
72 <test>
5
d2f6eac0ad42 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 355bb52d2e9d170b1db237e649657cc14e0a047a"
ebi-gxa
parents: 4
diff changeset
73 <param name="rds_seurat_file" ftype="rdata" value="E-MTAB-6077-3k_features_90_cells-fvg.rds"/>
4
4147dc085d45 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 2
diff changeset
74 <param name="vars_to_regress" value="nCount_RNA" />
4147dc085d45 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 2
diff changeset
75 <param name="use_umi" value="True" />
5
d2f6eac0ad42 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 355bb52d2e9d170b1db237e649657cc14e0a047a"
ebi-gxa
parents: 4
diff changeset
76 <output name="rds_seurat_file" ftype="rdata">
d2f6eac0ad42 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 355bb52d2e9d170b1db237e649657cc14e0a047a"
ebi-gxa
parents: 4
diff changeset
77 <assert_contents>
d2f6eac0ad42 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 355bb52d2e9d170b1db237e649657cc14e0a047a"
ebi-gxa
parents: 4
diff changeset
78 <has_size value="4233990" delta="200000"/>
d2f6eac0ad42 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 355bb52d2e9d170b1db237e649657cc14e0a047a"
ebi-gxa
parents: 4
diff changeset
79 </assert_contents>
d2f6eac0ad42 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 355bb52d2e9d170b1db237e649657cc14e0a047a"
ebi-gxa
parents: 4
diff changeset
80 </output>
0
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
81 </test>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
82 </tests>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
83 <help><![CDATA[
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
84 .. class:: infomark
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
85
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
86 **What it does**
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
87
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
88 This tool regresses out variables in a Seurat object to mitigate the effect of confounding factors.
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
89
1
3d0bfc2a233e planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents: 0
diff changeset
90 @SEURAT_INTRO@
0
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
91
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
92 -----
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
93
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
94 **Inputs**
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
95
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
96 * Seurat RDS object, probably normalised.
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
97 * Genes to use. A file with a vector of gene names to scale/center (one gene per line). Default is all genes in object@data.
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
98 * Variables to regress
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
99 * Statistical model to use.
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
100 * Use UMIs (boolean)
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
101 * Do centering (boolean)
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
102 * Scale maximum
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
103 * Block size
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
104 * Minimum number of cells to block
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
105 * Check that data is normalised
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
106
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
107 -----
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
108
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
109 **Outputs**
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
110
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
111 * Seurat RDS object, scaled.
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
112
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
113 .. _Seurat: https://www.nature.com/articles/nbt.4096
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
114 .. _Satija Lab: https://satijalab.org/seurat/
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
115
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
116 @VERSION_HISTORY@
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
117 ]]></help>
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
118 <expand macro="citations" />
6166efaeb4a6 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
119 </tool>