annotate qiime2/qiime_emperor_plot.xml @ 14:a0a8d77a991c draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:51:29 +0000
parents f190567fe3f6
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_plot" name="qiime emperor 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 Principal Coordinates Analysis Plots</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 plot
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-pcoa=$ipcoa
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
12 # if $input_files_mmetadatafile:
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
13 # def list_dict_to_string(list_dict):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
14 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
15 # for d in list_dict[1:]:
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
16 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
17 # end for
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
18 # return $file_list
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
19 # end def
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
20 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
21 # end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #if str($pcustomaxes):
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
24 --p-custom-axes=$pcustomaxes
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #if $pignoremissingsamples:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --p-ignore-missing-samples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 --o-visualization=ovisualization
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
31
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
32 #if str($examples) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
33 --examples=$examples
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
34 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
35
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 ;
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
37 cp odistancematrix.qza $odistancematrix
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
38
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
39 ;
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
40 qiime tools export ovisualization.qzv --output-path out
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
41 && mkdir -p '$ovisualization.files_path'
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
42 && cp -r out/* '$ovisualization.files_path'
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
43 && mv '$ovisualization.files_path/index.html' '$ovisualization'
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
44
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
45 ;
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
46 qiime tools export ovisualization.qzv --output-path out
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
47 && mkdir -p '$ovisualization.files_path'
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
51 ]]></command>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
52 <inputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
53 <param format="qza,no_unzip.zip" label="--i-pcoa: ARTIFACT The principal coordinates matrix to be plotted. PCoAResults [required]" name="ipcoa" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
54 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
55 <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
56 </repeat>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
57 <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
58 <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
59 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
60
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
61 </inputs>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
63 <outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
64 <data format="html" label="${tool.name} on ${on_string}: visualization.html" name="ovisualization" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
65
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
66 </outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
67
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
68 <help><![CDATA[
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 Visualize and Interact with Principal Coordinates Analysis Plots
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
70 ###############################################################
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 Generates an interactive ordination plot where the user can visually
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 integrate sample metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 pcoa : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 The principal coordinates matrix to be plotted.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 The sample metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 custom_axes : List[Str], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 Numeric sample metadata columns that should be included as axes in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 Emperor plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 ignore_missing_samples : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 This will suppress the error raised when the coordinates matrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 contains samples that are not present in the metadata. Samples without
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 metadata are included by setting all metadata values to: "This sample
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 has no metadata". This flag is only applied if at least one sample is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 present in both the coordinates matrix and the metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 visualization : Visualization
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
94 ]]></help>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
95 <macros>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 <import>qiime_citation.xml</import>
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
97 </macros>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
98 <expand macro="qiime_citation"/>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
99 </tool>