annotate qiime2-2020.8/qiime_emperor_procrustes-plot.xml @ 22:292c84bd5ab6 draft

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