Mercurial > repos > ebi-gxa > seurat_scale_data

comparison seurat_scale_data.xml @ 1:3d0bfc2a233e draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
author ebi-gxa
date Mon, 25 Nov 2019 06:11:23 -0500
parents 6166efaeb4a6
children 1a8e93921f01
comparison
equal deleted inserted replaced
0:6166efaeb4a6 1:3d0bfc2a233e
1 <tool id="seurat_scale_data" name="Seurat ScaleData" version="2.3.1+galaxy1"> 1 <tool id="seurat_scale_data" name="Seurat ScaleData" version="@SEURAT_VERSION@_@VERSION@+galaxy0">
2 <description>scale and center genes</description> 2 <description>scale and center genes</description>
3 <macros> 3 <macros>
4 <import>seurat_macros.xml</import> 4 <import>seurat_macros.xml</import>
5 </macros> 5 </macros>
6 <expand macro="requirements" /> 6 <expand macro="requirements" />
7 <expand macro="version" /> 7 <expand macro="version" />
8 <command detect_errors="exit_code"><![CDATA[ 8 <command detect_errors="exit_code"><![CDATA[
9 seurat-scale-data.R 9 seurat-scale-data.R
10 10
11 --input-object-file '$input' 11 @INPUT_OBJECT@
12 #if $vars: 12 #if $vars:
13 --vars-to-regress '$vars' 13 --vars-to-regress '$vars'
14 #else 14 #else
15 --vars-to-regress nUMI 15 --vars-to-regress nUMI
16 #end if 16 #end if
17 17
18 #if $genes: 18 #if $genes_use:
19 --genes-use '$genes' 19 --genes-use '$genes_use'
20 #end if 20 #end if
21 21
22 --model-use '$model' 22 --model-use '$model'
23 23
24 $use_umi 24 $use_umi
25 $do_center 25 $do_not_center
26 26
27 #if $scale_max: 27 #if $scale_max:
28 --scale-max '$scale_max' 28 --scale-max '$scale_max'
29 #end if 29 #end if
30 30
36 --min-cells-to-block '$min_cells_to_block' 36 --min-cells-to-block '$min_cells_to_block'
37 #end if 37 #end if
38 38
39 $check_for_norm 39 $check_for_norm
40 40
41 41 @OUTPUT_OBJECT@
42
43 --output-object-file '$output'
44 ]]></command> 42 ]]></command>
45 43
46 <inputs> 44 <inputs>
47 <param name="input" argument="--input-object-file" type='data' format='rdata' help="File name in where a serialized R matrix object can be found." label="Seurat RDS object"/> 45 <expand macro="input_object_params"/>
48 <param name="genes" argument="--genes-use" type='data' format='txt' optional='true' help="File to be used to derive a vector of gene names to scale/center (one gene per line). Default is all genes in object@data."/> 46 <expand macro="output_object_params"/>
49 <param name="vars" argument="--vars-to-regress" type='text' optional='True' label="Vars to regress" help="Comma-separated list of variables to regress out (previously latent.vars in RegressOut). For example, nUMI, or percent.mito."/> 47 <expand macro="genes-use-input"/>
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.">
49 <validator type="regex" message="Please only use letters or numbers">^[\(\w\)]+$</validator>
50 <option value="nCount_RNA">nCount_RNA</option>
51 <option value="nFeature_RNA">nFeature_RNA</option>
52 </param>
50 <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."> 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.">
51 <option value="linear" selected="true">Linear model</option> 54 <option value="linear" selected="true">Linear model</option>
52 <option value="poisson">Poisson model</option> 55 <option value="poisson">Poisson model</option>
53 <option value="negbinom">Negative binomial model</option> 56 <option value="negbinom">Negative binomial model</option>
54 </param> 57 </param>
55 <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'."/> 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'."/>
56 <param name="do_center" argument="--do-center" type="boolean" falsevalue="--do-center FALSE" truevalue="" checked="true" label="Perform centering" help="Whether to center the data."/> 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."/>
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."/>
57 <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."/> 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."/>
58 <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."/> 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."/>
59 <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."/> 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."/>
60 <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."/> 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."/>
61 </inputs> 65 </inputs>
62 66
63 <outputs> 67 <outputs>
64 <data name="output" format="rdata" from_work_dir="*.rds" label="${tool.name} on ${on_string}: Seurat RDS"/> 68 <expand macro="output_files"/>
65 </outputs> 69 </outputs>
66 70
67 <tests> 71 <tests>
68 <test> 72 <test>
69 <param name="input" ftype="rdata" value="out_findvar.rds"/> 73 <param name="input" ftype="rdata" value="out_findvar.rds"/>
70 <output name="output" ftype="rdata" value="out_scale.rds" compare="sim_size"/> 74 <output name="rds_seurat_file" ftype="rdata" value="out_scale.rds" compare="sim_size"/>
71 </test> 75 </test>
72 </tests> 76 </tests>
73 <help><![CDATA[ 77 <help><![CDATA[
74 .. class:: infomark 78 .. class:: infomark
75 79
76 **What it does** 80 **What it does**
77 81
78 Seurat_ is a toolkit for quality control, analysis, and exploration of single cell RNA sequencing data.
79 It is developed and maintained by the `Satija Lab`_ at NYGC. Seurat aims to enable users to identify and
80 interpret sources of heterogeneity from single cell transcriptomic measurements, and to integrate diverse
81 types of single cell data.
82
83 This tool regresses out variables in a Seurat object to mitigate the effect of confounding factors. 82 This tool regresses out variables in a Seurat object to mitigate the effect of confounding factors.
84 83
84 @SEURAT_INTRO@
85 85
86 ----- 86 -----
87 87
88 **Inputs** 88 **Inputs**
89 89