annotate qiime2-2020.8/qiime_emperor_plot.xml @ 26:60da5215e182 draft

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