annotate seurat_find_neighbours.xml @ 3:ab622ffd7c7f draft

"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:48:19 +0000
parents bba8b14264c2
children 99d628557c47
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
bba8b14264c2 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit bbe3c1f7fd8489951f2d90415fe80dd5cf961ca0
ebi-gxa
parents: 0
diff changeset
1 <tool id="seurat_find_neighbours" name="Seurat FindNeighbours" version="@SEURAT_VERSION@+galaxy0">
0
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
2 <description>constructs a Shared Nearest Neighbor (SNN) Graph</description>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
3 <macros>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
4 <import>seurat_macros.xml</import>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
5 </macros>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
6 <expand macro="requirements" />
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
7 <expand macro="version" />
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
9 seurat-find-neighbours.R
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
10 @INPUT_OBJECT@
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
11 $distance_matrix
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
12 #if $k_param
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
13 --k-param '$k_param'
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
14 #end if
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
15 $compute_snn
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
16 #if $prune_snn
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
17 --prune-snn '$prune_snn'
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
18 #end if
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
19 #if $nn_method
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
20 --nn-method '$nn_method'
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
21 #end if
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
22 #if $annoy_metric
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
23 --annoy-metric '$annoy_metric'
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
24 #end if
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
25 #if $graph_name
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
26 --graph-name '$graph_name'
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
27 #end if
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
28 #if $nn_eps and $nn_method == "rann"
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
29 --nn-eps '$nn_eps'
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
30 #end if
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
31 $force_recalc
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
32 #if $features_file
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
33 --features '$features_file'
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
34 #else if $features
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
35 --features '$features'
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
36 #end if
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
37 #if $reduction
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
38 --reduction '$reduction'
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
39 #end if
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
40 #if $dims
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
41 --dims '$dims'
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
42 #end if
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
43 #if $assay
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
44 --assay '$assay'
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
45 #end if
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
46 #if $do_plot
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
47 $do_plot
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
48 #end if
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
49 @OUTPUT_OBJECT@
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
50 ]]></command>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
51
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
52 <inputs>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
53 <expand macro="input_object_params"/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
54 <expand macro="output_object_params"/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
55 <param label="Features" optional="true" name="features" argument="--features" type="text" help="Comma-separated list of genes to use for building SNN."/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
56 <param label="Features file" optional="true" name="features_file" argument="--features" type="data" format="txt,tabular" help="Text file with one gene per line to use for building SNN. Overrides Features."/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
57 <param label="Plot SNN on tSNE" optional="true" name="do_plot" argument="--do-plot" type="boolean" truevalue="--do-plot" checked="false" help="Plot SNN graph on tSNE coordinates"/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
58 <param label="Reduction" optional="true" name="reduction" argument="--reduction" type="text" help="Reduction to use as input for building the SNN"/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
59 <param label="Dimensions" optional="true" name="dims" argument="--dims" type="text" help="Dimensions of reduction to use as input. A comma-separated list of the dimensions to use in construction of the SNN graph (e.g. To use the first 5 PCs, pass 1,2,3,4,5)."/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
60 <param label="Assay" optional="true" name="assay" argument="--assay" type="text" help="Assay to use in construction of SNN"/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
61 <param label="Distance matrix" optional="true" name="distance_matrix" argument="--distance-matrix" type="boolean" truevalue="--distance-matrix" falsevalue="" checked="false" help="Boolean value of whether the provided matrix is a distance matrix; note, for objects of class dist, this parameter will be set automatically."/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
62 <param label="k" optional="true" name="k_param" argument="--k-param" type="integer" help="Defines k for the k-nearest neighbor algorithm"/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
63 <param label="Compute SNN" optional="true" name="compute_snn" argument="--compute-snn" type="boolean" truevalue="--compute-snn" falsevalue="" checked="false" help="Also compute the shared nearest neighbor graph"/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
64 <param label="Prune SNN" optional="true" name="prune_snn" argument="--prune-snn" type="float" help="Sets the cutoff for acceptable Jaccard index when computing the neighborhood overlap for the SNN construction. Any edges with values less than or equal to this will be set to 0 and removed from the SNN graph. Essentially sets the strigency of pruning (0 --- no pruning, 1 --- prune everything)."/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
65 <param label="NN method" optional="true" name="nn_method" argument="--nn-method" type="select" help="Method for nearest neighbor finding. Options include: rann (default), annoy">
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
66 <option value="rann" selected="true">rann</option>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
67 <option value="annoy">annoy</option>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
68 </param>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
69 <param label="Annoy metric" optional="true" name="annoy_metric" argument="--annoy-metric" type="select" help="Distance metric for annoy. Options include: euclidean (default), cosine, manhattan, and hamming">
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
70 <option value="euclidean" selected="true">Euclidean</option>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
71 <option value="cosine">Cosine</option>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
72 <option value="manhattan">Manhattan</option>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
73 <option value="hamming">Hamming</option>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
74 </param>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
75 <param label="Graph name" optional="true" name="graph_name" argument="--graph-name" type="text" help="Name of graph to use for the clustering algorithm."/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
76 <param label="NN Error bound" optional="true" name="nn_eps" argument="--nn-eps" type="float" help="Error bound when performing nearest neighbor seach using RANN; default of 0.0 implies exact nearest neighbor search"/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
77 <param label="Force recalc" optional="true" name="force_recalc" argument="--force-recalc" type="boolean" truevalue="--force-recalc" falsevalue="" checked="false" help="Force recalculation of SNN"/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
78 </inputs>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
79
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
80 <outputs>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
81 <expand macro="output_files"/>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
82 <data name="snn_on_tsne" format="pdf" from_work_dir="snn_on_tsne.pdf" label="${tool.name} on ${on_string}: SNN on tSNE Plot">
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
83 <filter>do_plot</filter>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
84 </data>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
85 </outputs>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
86
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
87 <tests>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
88 <test>
3
ab622ffd7c7f "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 1
diff changeset
89 <param name="rds_seurat_file" ftype="rdata" value="pca_seurat.rds"/>
ab622ffd7c7f "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 1
diff changeset
90 <param name="compute_snn" value="True" />
ab622ffd7c7f "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 1
diff changeset
91 <param name="reduction" value="pca" />
ab622ffd7c7f "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit a1ad1ddd9b8e4db5bb82c3accae8311e0e488b19"
ebi-gxa
parents: 1
diff changeset
92 <output name="rds_seurat_file" ftype="rdata" value="neighbours_seurat.rds" compare="sim_size" delta="10000000" />
0
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
93 </test>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
94 </tests>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
95 <help><![CDATA[
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
96 .. class:: infomark
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
97
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
98 **What it does**
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
99
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
100 Constructs a Shared Nearest Neighbor (SNN) Graph for a given dataset.
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
101 We first determine the k-nearest neighbors of each cell. We use this knn graph
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
102 to construct the SNN graph by calculating the neighborhood overlap (Jaccard index)
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
103 between every cell and its k.param nearest neighbors.
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
104
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
105 @SEURAT_INTRO@
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
106
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
107 -----
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
108
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
109 **Inputs**
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
110
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
111 * Seurat RDS object. Probably the one produced by Seurat create object.
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
112 * Subset names. A list of attributes to subset on, colon separated (:).
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
113 * Low thresholds. A minimum value for each of the attributes set in subset names, again, colon separated (:). Optional.
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
114 * High thresholds. A maximum value for each of the attributes set in subset names, again, colon separated (:). Optional.
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
115 * Cells to use. A list of cell names/idenfifiers to filter positively by.
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
116
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
117 -----
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
118
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
119 **Outputs**
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
120
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
121 * Seurat RDS object filtered according to the inputs.
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
122
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
123 .. _Seurat: https://www.nature.com/articles/nbt.4096
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
124 .. _Satija Lab: https://satijalab.org/seurat/
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
125
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
126 @VERSION_HISTORY@
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
127
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
128 ]]></help>
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
129 <expand macro="citations" />
4fff8ad1c76d planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0463f230d18201c740851d72e31a5024f391207f
ebi-gxa
parents:
diff changeset
130 </tool>