annotate qiime2/qiime_emperor_procrustes-plot.xml @ 15:276ec629f09a draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:56:05 +0000
parents a0a8d77a991c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
2 <tool id="qiime_emperor_procrustes-plot" name="qiime emperor procrustes-plot"
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
3 version="2020.8">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
4 <description>Visualize and Interact with a procrustes plot</description>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
5 <requirements>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
7 </requirements>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
8 <command><![CDATA[
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9 qiime emperor procrustes-plot
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-reference-pcoa=$ireferencepcoa
4
florianbegusch
parents: 0
diff changeset
12
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 --i-other-pcoa=$iotherpcoa
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
14 # if $input_files_mmetadatafile:
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
15 # def list_dict_to_string(list_dict):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
16 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
17 # for d in list_dict[1:]:
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
18 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
19 # end for
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
20 # return $file_list
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
21 # end def
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
22 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
23 # end if
4
florianbegusch
parents: 0
diff changeset
24
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #if str($pcustomaxes):
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
26 --p-custom-axes=$pcustomaxes
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #if $pignoremissingsamples:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 --p-ignore-missing-samples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 --o-visualization=ovisualization
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
33
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
34 #if str($examples) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
35 --examples=$examples
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
36 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
37
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 ;
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
39 cp odistancematrix.qza $odistancematrix
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
40
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
41 ;
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
42 qiime tools export ovisualization.qzv --output-path out
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
43 && mkdir -p '$ovisualization.files_path'
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
44 && cp -r out/* '$ovisualization.files_path'
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
45 && mv '$ovisualization.files_path/index.html' '$ovisualization'
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
46
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
47 ;
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
48 qiime tools export ovisualization.qzv --output-path out
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
49 && mkdir -p '$ovisualization.files_path'
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 && mv '$ovisualization.files_path/index.html' '$ovisualization'
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
52
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
53 ;
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
54 qiime tools export ovisualization.qzv --output-path out
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
55 && mkdir -p '$ovisualization.files_path'
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
56 && cp -r out/* '$ovisualization.files_path'
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
57 && mv '$ovisualization.files_path/index.html' '$ovisualization'
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
59 ]]></command>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
60 <inputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
61 <param format="qza,no_unzip.zip" label="--i-reference-pcoa: ARTIFACT PCoAResults The reference ordination matrix to be plotted. [required]" name="ireferencepcoa" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
62 <param format="qza,no_unzip.zip" label="--i-other-pcoa: ARTIFACT PCoAResults The \'other\' ordination matrix to be plotted (the one that was fitted to the reference). [required]" name="iotherpcoa" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
63 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
64 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA... (multiple The sample metadata. arguments will be merged) [required]" name="additional_input" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
65 </repeat>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
66 <param label="--p-custom-axes: TEXT... List[Str] Numeric sample metadata columns that should be included as axes in the Emperor plot. [optional]" name="pcustomaxes" optional="False" type="text" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
67 <param label="--p-ignore-missing-samples: --p-ignore-missing-samples: / --p-no-ignore-missing-samples This will suppress the error raised when the coordinates matrix contains samples that are not present in the metadata. Samples without metadata are included by setting all metadata values to: \'This sample has no metadata\'. This flag is only applied if at least one sample is present in both the coordinates matrix and the metadata. [default: False]" name="pignoremissingsamples" selected="False" type="boolean" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
68 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
69
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
70 </inputs>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
72 <outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
73 <data format="html" label="${tool.name} on ${on_string}: visualization.html" name="ovisualization" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
74
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
75 </outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
76
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
77 <help><![CDATA[
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 Visualize and Interact with a procrustes plot
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
79 ###############################################################
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 Plot two procrustes-fitted matrices
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 reference_pcoa : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 The reference ordination matrix to be plotted.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 other_pcoa : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 The "other" ordination matrix to be plotted (the one that was fitted to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 the reference).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 The sample metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 custom_axes : List[Str], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 Numeric sample metadata columns that should be included as axes in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 Emperor plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 ignore_missing_samples : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 This will suppress the error raised when the coordinates matrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 contains samples that are not present in the metadata. Samples without
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 metadata are included by setting all metadata values to: "This sample
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 has no metadata". This flag is only applied if at least one sample is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 present in both the coordinates matrix and the metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 visualization : Visualization
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
105 ]]></help>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
106 <macros>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 <import>qiime_citation.xml</import>
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
108 </macros>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
109 <expand macro="qiime_citation"/>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
110 </tool>