annotate sc3-calc-transfs.xml @ 0:ed7d0532545c draft

planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
author ebi-gxa
date Wed, 13 Mar 2019 17:38:56 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
2 <tool id="sc3_calc_transfs" name="SC3 Calculate Transformations" version="@TOOL_VERSION@+galaxy0">
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
3 <description>of distances using PCA and graph Laplacian</description>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
4 <macros>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
5 <import>sc3-macros.xml</import>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
6 </macros>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
7 <expand macro="requirements" />
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
9 sc3-sc3-calc-transfs.R -i '${sc3_distances}' -o '${sc3_transformed}'
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
10 ]]></command>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
11
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
12 <inputs>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
13 <param name="sc3_distances" type="data" format="rdata" label="Serialised sc3 SingleCellExperiment object with distances calculated"/>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
14 </inputs>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
15
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
16 <outputs>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
17 <data name="sc3_transformed" format="rdata" label="${tool.name} on ${on_string}: serialised sc3 SingleCellExperiment object with transformed distances"/>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
18 </outputs>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
19
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
20 <tests>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
21 <test>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
22 <param name="sc3_distances" value="sc3_distances.rdata"/>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
23 <output name="sc3_transformed" file="sc3_transformed.rdata"/>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
24 </test>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
25 </tests>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
26
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
27 <help><![CDATA[
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
28 ==============================================
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
29 This function calculate transformed distances.
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
30 ==============================================
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
31
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
32 All items of the sc3 slot of the metadata(object) are transformed using either
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
33 principal component analysis (PCA) or by calculating the eigenvectors of the
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
34 associated graph Laplacian. The columns of the resulting matrices are then
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
35 sorted in descending order by their corresponding eigenvalues. The first d
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
36 columns (where d = max(metadata(object)$sc3$n_dim)) of each transformation are
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
37 then written to the transformations item of the sc3 slot. Additionally, this
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
38 function also removes the previously calculated distances from the sc3 slot, as
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
39 they are not needed for further analysis.
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
40
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
41 @HELP@
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
42
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
43 @VERSION_HISTORY@
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
44 ]]></help>
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
45 <expand macro="citations" />
ed7d0532545c planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 0a95e950ac73efdc9e84025ecb547e66fc3b83f6
ebi-gxa
parents:
diff changeset
46 </tool>