annotate seurat_run_tsne.xml @ 0:3aea769deab1 draft

planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
author ebi-gxa
date Wed, 03 Apr 2019 11:19:13 -0400
parents
children 13a27436f8ee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
1 <tool id="seurat_run_tsne" name="Seurat RunTSNE" version="2.3.1+galaxy1">
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
2 <description>run t-SNE dimensionality reduction</description>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
3 <macros>
3aea769deab1 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>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
5 </macros>
3aea769deab1 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" />
3aea769deab1 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" />
3aea769deab1 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[
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
9 seurat-run-tsne.R
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
10
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
11 --input-object-file '$input'
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
12
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
13 #if $genes_use:
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
14 --genes-use '$genes_use'
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
15 #end if
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
16
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
17 #if str($adv.dims_use):
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
18 --dims-use \$(seq -s , 1 '$adv.dims_use')
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
19 #else
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
20 --dims-use 1,10
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
21 #end if
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
22
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
23 #if not $adv.do_fast:
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
24 --do-fast '$adv.do_fast'
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
25 #end if
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
26
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
27 --output-object-file '$output'
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
28 --output-embeddings-file output_embed
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
29 ]]></command>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
30
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
31 <inputs>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
32 <param name="input" argument="--input-obj-file" type="data" format="rdata" label="Seurat RDS object" help="The RDS/Rdata result of Seurat FindClusters."/>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
33 <expand macro="genes-use-input"/>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
34 <section name="adv" title="Advanced Options">
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
35 <expand macro="dims-use-input"/>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
36 <param name="do_fast" label="Faster execution" argument="--do-fast" checked="true" type="boolean" truevalue="" falsevalue="FALSE" help="If TRUE, uses the Barnes-hut implementation, which runs faster, but is less flexible. TRUE by default."/>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
37 </section>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
38 </inputs>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
39
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
40 <outputs>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
41 <data name="output" format="rdata" from_work_dir="*.rds" label="${tool.name} on ${on_string}: Seurat RDS"/>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
42 <data name="output_embed" format="csv" from_work_dir="output_embed" label="${tool.name} on ${on_string}: Seurat Embeddings"/>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
43 </outputs>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
44
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
45 <tests>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
46 <test>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
47 <param name="input" ftype="rdata" value="out_findclust.rds"/>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
48 <output name="output" ftype="rdata" value="out_runtsne.rds" compare="sim_size"/>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
49 </test>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
50 </tests>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
51 <help><![CDATA[
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
52 .. class:: infomark
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
53
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
54 **What it does**
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
55
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
56 Seurat_ is a toolkit for quality control, analysis, and exploration of single cell RNA sequencing data.
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
57 It is developed and maintained by the `Satija Lab`_ at NYGC. Seurat aims to enable users to identify and
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
58 interpret sources of heterogeneity from single cell transcriptomic measurements, and to integrate diverse
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
59 types of single cell data.
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
60
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
61 Run t-SNE dimensionality reduction on selected features. Has the option of
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
62 running in a reduced dimensional space (i.e. spectral tSNE, recommended),
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
63 or running based on a set of genes. For details about stored TSNE calculation
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
64 parameters, see standard output of the tool.
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
65
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
66 -----
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
67
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
68 **Inputs**
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
69
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
70 * RDS object
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
71
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
72 -----
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
73
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
74 **Outputs**
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
75
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
76 * Seurat RDS object
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
77
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
78 .. _Seurat: https://www.nature.com/articles/nbt.4096
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
79 .. _Satija Lab: https://satijalab.org/seurat/
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
80
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
81 @VERSION_HISTORY@
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
82 ]]></help>
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
83 <expand macro="citations" />
3aea769deab1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 9bf9a6e46a330890be932f60d1d996dd166426c4
ebi-gxa
parents:
diff changeset
84 </tool>