annotate qiime2/qiime_emperor_plot.xml @ 29:3ba9833030c1 draft

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