annotate monocle3-preprocess.xml @ 1:0869b0264af1 draft

planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 08ac0ad9182623944c4546f8ea8db6a1a537f7eb
author ebi-gxa
date Wed, 29 Jan 2020 10:38:23 -0500
parents 384b9bcf2807
children 273d11a83e42
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
384b9bcf2807 "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"?>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
2 <tool id="monocle3_preprocess" name="Monocle3 preprocess" version="@TOOL_VERSION@+galaxy0">
384b9bcf2807 "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 to an initially dimensionally reduced space</description>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
4 <macros>
384b9bcf2807 "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>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
6 </macros>
384b9bcf2807 "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"/>
384b9bcf2807 "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[
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
9 LANG=en_US.UTF-8 monocle3 preprocess
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
10 --method '${method}'
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
11 #if $num_dim
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
12 --num-dim '${num_dim}'
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
13 #end if
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
14 --norm-method '${norm_method}'
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
15 #if $use_genes
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
16 --use-genes '${use_genes}'
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
17 #end if
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
18 #if $residual_model_formula_str
1
0869b0264af1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 08ac0ad9182623944c4546f8ea8db6a1a537f7eb
ebi-gxa
parents: 0
diff changeset
19 --residual-model-formula-str '${residual_model_formula_str}'
0
384b9bcf2807 "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
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
21 #if $pseudo_count
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
22 --pseudo-count '${pseudo_count}'
384b9bcf2807 "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
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
24 #if $no_scaling
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
25 --no-scaling
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
26 #end if
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
27
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
28 @INPUT_OPTS@
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
29 @OUTPUT_OPTS@
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
30
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
31 @VERBOSE@
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
32 ]]></command>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
33
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
34 <inputs>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
35 <expand macro="input_object_params"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
36 <expand macro="output_object_params"/>
384b9bcf2807 "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="method" argument="--method" type="select" label="Initial dimensionality reduction to perform.">
384b9bcf2807 "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="PCA" selected="true">PCA</option>
384b9bcf2807 "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="LSI">LSI</option>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
40 </param>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
41 <param name="num_dim" argument="--num-dim" optional="true" type="integer" value="50" label="The dimensionality of the reduced space."/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
42 <param name="norm_method" argument="--norm-method" type="select" label="Determines how to transform expression values prior to reducing dimensionality.">
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
43 <option value="log" selected="true">Size factor correction and log transformation</option>
384b9bcf2807 "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="size_only">Size factor correction only</option>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
45 </param>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
46 <param name="use_genes" argument="--use-genes" type="text" optional="true" label="Manually subset the gene pool to these genes for dimensionality reduction."/>
1
0869b0264af1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 08ac0ad9182623944c4546f8ea8db6a1a537f7eb
ebi-gxa
parents: 0
diff changeset
47 <param name="residual_model_formula_str" argument="--residual-model-formula-str" type="text" optional="true" label="A string model formula specifying effects to subtract from the data.">
0869b0264af1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 08ac0ad9182623944c4546f8ea8db6a1a537f7eb
ebi-gxa
parents: 0
diff changeset
48 <sanitizer>
0869b0264af1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 08ac0ad9182623944c4546f8ea8db6a1a537f7eb
ebi-gxa
parents: 0
diff changeset
49 <valid initial="string.printable"/>
0869b0264af1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 08ac0ad9182623944c4546f8ea8db6a1a537f7eb
ebi-gxa
parents: 0
diff changeset
50 </sanitizer>
0869b0264af1 planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 08ac0ad9182623944c4546f8ea8db6a1a537f7eb
ebi-gxa
parents: 0
diff changeset
51 </param>
0
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
52 <param name="pseudo_count" argument="--pseudo-count" optional="true" type="float" value="1" label="Amount to increase expression values before dimensionality reduction."/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
53 <param name="no_scaling" argument="--no-scaling" type="boolean" checked="false" label="When this option is NOT set, scale each gene before running trajectory reconstruction."/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
54 <expand macro="verbose_flag"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
55 </inputs>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
56
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
57 <outputs>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
58 <data name="output_rds" format="rdata" from_work_dir="output.RDS" label="${tool.name} on ${on_string}: ${output_object_format}"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
59 </outputs>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
60
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
61 <tests>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
62 <test>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
63 <param name="input_object_file" value="input.RDS"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
64 <param name="input_object_format" value="cds3"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
65 <param name="method" value="PCA"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
66 <param name="num_dim" value="50"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
67 <param name="norm_method" value="log"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
68 <param name="pseudo_count" value="1"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
69 <param name="output_object_format" value="cds3"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
70 <output name="output_rds" file="output.rds" ftype="rdata" compare="sim_size"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
71 </test>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
72 </tests>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
73
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
74 <help><![CDATA[
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
75 ====================================================================================
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
76 Preprocess Monocle3 object up to initial dimensionality reduction (`preprocess_cds`)
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
77 ====================================================================================
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
78
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
79 Preprocess a Monocle3 object with size factor scaling of the count data, optionally
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
80 log transforming, and computing an initial dimensionality reduction. This space is
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
81 used as a starting point for a number of subsequent analyses.
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
82
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
83 @HELP@
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
84
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
85 @VERSION_HISTORY@
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
86 ]]></help>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
87 <expand macro="citations"/>
384b9bcf2807 "planemo upload for repository https://github.com/ebi-gene-expression-group/container-galaxy-sc-tertiary/ commit 815e36252846236124957052433572f1c1247114"
ebi-gxa
parents:
diff changeset
88 </tool>