annotate monocle3-create.xml @ 3:46a523dc303f draft

"planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 660486ba0e1ef2f0195e7c6f75448221ba4640f7"
author ebi-gxa
date Tue, 28 Apr 2020 11:51:46 -0400
parents 2e446b0cb437
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
3
46a523dc303f "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 660486ba0e1ef2f0195e7c6f75448221ba4640f7"
ebi-gxa
parents: 2
diff changeset
2 <tool id="monocle3_create" name="Monocle3 create" version="@TOOL_VERSION@+galaxy2" profile="@PROFILE@">
0
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
3 <description>a Monocle3 object from input data</description>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
4 <macros>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
5 <import>monocle3-macros.xml</import>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
6 </macros>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
7 <expand macro="requirements"/>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
9 ln -s '${expression_matrix}' expression_matrix.'${expression_matrix_format}' &&
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
10 #if $cell_metadata
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
11 ln -s '${cell_metadata}' cell_metadata.'${cell_metadata_format}' &&
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
12 #end if
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
13 #if $gene_annotation
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
14 ln -s '${gene_annotation}' gene_annotation.'${gene_annotation_format}' &&
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
15 #end if
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
16 LANG=en_US.UTF-8 monocle3 create
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
17 --expression-matrix expression_matrix.'${expression_matrix_format}'
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
18 #if $cell_metadata
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
19 --cell-metadata cell_metadata.'${cell_metadata_format}'
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
20 #end if
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
21 #if $gene_annotation
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
22 --gene-annotation gene_annotation.'${gene_annotation_format}'
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
23 #end if
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
24 @OUTPUT_OPTS@
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
25 @VERBOSE@
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
26 ]]></command>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
27
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
28 <inputs>
1
a34f243f55a4 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 08ac0ad9182623944c4546f8ea8db6a1a537f7eb
ebi-gxa
parents: 0
diff changeset
29 <param name="expression_matrix" argument="--expression-matrix" type="data" format="tabular,tsv,csv,rdata" label="Expression matrix, genes as rows, cells as columns. Required input. Provide as TSV, CSV or RDS."/>
0
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
30 <param name="expression_matrix_format" type="select" label="Format of expression matrix">
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
31 <option value="rds" selected="true">RDS</option>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
32 <option value="tsv">TSV</option>
3
46a523dc303f "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 660486ba0e1ef2f0195e7c6f75448221ba4640f7"
ebi-gxa
parents: 2
diff changeset
33 <option value="mtx">MTX</option>
0
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
34 <option value="csv">CSV</option>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
35 </param>
1
a34f243f55a4 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 08ac0ad9182623944c4546f8ea8db6a1a537f7eb
ebi-gxa
parents: 0
diff changeset
36 <param name="cell_metadata" argument="--cell-metadata" optional="true" type="data" format="tabular,tsv,csv,rdata" label="Per-cell annotation, optional. Row names must match the column names of the expression matrix. Provide as TSV, CSV or RDS."/>
0
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
37 <param name="cell_metadata_format" type="select" label="Format of cell metadata">
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
38 <option value="rds" selected="true">RDS</option>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
39 <option value="tsv">TSV</option>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
40 <option value="csv">CSV</option>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
41 </param>
1
a34f243f55a4 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 08ac0ad9182623944c4546f8ea8db6a1a537f7eb
ebi-gxa
parents: 0
diff changeset
42 <param name="gene_annotation" argument="--gene-annotation" optional="true" type="data" format="tabular,tsv,csv,rdata" label="Per-gene annotation, optional. Row names must match the row names of the expression matrix. Provide as TSV, CSV or RDS."/>
0
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
43 <param name="gene_annotation_format" type="select" label="Format of gene annotation">
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
44 <option value="rds" selected="true">RDS</option>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
45 <option value="tsv">TSV</option>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
46 <option value="csv">CSV</option>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
47 </param>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
48 <expand macro="output_object_params"/>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
49 <expand macro="verbose_flag"/>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
50 </inputs>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
51
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
52 <outputs>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
53 <data name="output_rds" format="rdata" from_work_dir="output.RDS" label="${tool.name} on ${on_string}: ${output_object_format}"/>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
54 </outputs>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
55
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
56 <tests>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
57 <test>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
58 <param name="expression_matrix" value="expression.RDS"/>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
59 <param name="cell_metadata" value="cells.RDS"/>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
60 <param name="gene_annotation" value="genes.RDS"/>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
61 <param name="output_object_format" value="cds3"/>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
62 <output name="output_rds" file="output.rds" ftype="rdata" compare="sim_size"/>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
63 </test>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
64 </tests>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
65
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
66 <help><![CDATA[
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
67 ===========================================================================
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
68 Create Monocle3 object from input expression/metadata (`new_cell_data_set`)
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
69 ===========================================================================
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
70
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
71 Create a Monocle3 cds3 object from input expression data and optional metadata.
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
72 The expression matrix, with genes as rows and cells as columns, is the only mandatory
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
73 input. The cell metadata (with row names matching the column names of the expression
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
74 matrix) and gene annotation (with row names matching the row names of the expression
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
75 matrix) are optional. These files can be provided as RDS objects, or CSV/TSV. Select the
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
76 format of your input files in the corresponding drop-downs.
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
77
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
78 @HELP@
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
79
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
80 @VERSION_HISTORY@
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
81 ]]></help>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
82 <expand macro="citations"/>
75340a5e5fb0 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
83 </tool>