annotate qiime2/qiime_emperor_biplot.xml @ 4:71f124e02000 draft default tip

Fixes
author florianbegusch
date Tue, 13 Aug 2019 07:40:25 -0400
parents 149432539226
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_emperor_biplot" name="qiime emperor biplot" version="2019.4">
149432539226 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Visualize and Interact with Principal Coordinates Analysis Biplot</description>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
149432539226 Uploaded
florianbegusch
parents:
diff changeset
8 qiime emperor biplot
149432539226 Uploaded
florianbegusch
parents:
diff changeset
9
149432539226 Uploaded
florianbegusch
parents:
diff changeset
10 --i-biplot=$ibiplot
149432539226 Uploaded
florianbegusch
parents:
diff changeset
11
149432539226 Uploaded
florianbegusch
parents:
diff changeset
12
4
florianbegusch
parents: 2
diff changeset
13 #if $m_sample_metadatafile:
florianbegusch
parents: 2
diff changeset
14 #def list_dict_to_string_sample_mdata(list_dict):
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
15 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
149432539226 Uploaded
florianbegusch
parents:
diff changeset
16 #for d in list_dict[1:]:
4
florianbegusch
parents: 2
diff changeset
17 #set $file_list = $file_list + ' --m-sample-metadata-file=' + d['additional_input'].__getattr__('file_name')
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
18 #end for
149432539226 Uploaded
florianbegusch
parents:
diff changeset
19 #return $file_list
149432539226 Uploaded
florianbegusch
parents:
diff changeset
20 #end def
4
florianbegusch
parents: 2
diff changeset
21 --m-sample-metadata-file=$list_dict_to_string_sample_mdata($m_sample_metadatafile)
florianbegusch
parents: 2
diff changeset
22 #end if
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
23
4
florianbegusch
parents: 2
diff changeset
24
florianbegusch
parents: 2
diff changeset
25
florianbegusch
parents: 2
diff changeset
26 #if $m_feature_metadatafile:
florianbegusch
parents: 2
diff changeset
27 #def list_dict_to_string_feature_mdata(list_dict):
florianbegusch
parents: 2
diff changeset
28 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
florianbegusch
parents: 2
diff changeset
29 #for d in list_dict[1:]:
florianbegusch
parents: 2
diff changeset
30 #set $file_list = $file_list + ' --m-feature-metadata-file=' + d['additional_input'].__getattr__('file_name')
florianbegusch
parents: 2
diff changeset
31 #end for
florianbegusch
parents: 2
diff changeset
32 #return $file_list
florianbegusch
parents: 2
diff changeset
33 #end def
florianbegusch
parents: 2
diff changeset
34 --m-feature-metadata-file=$list_dict_to_string_feature_mdata($m_feature_metadatafile)
florianbegusch
parents: 2
diff changeset
35 #end if
florianbegusch
parents: 2
diff changeset
36
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
37
149432539226 Uploaded
florianbegusch
parents:
diff changeset
38
149432539226 Uploaded
florianbegusch
parents:
diff changeset
39 #if $pignoremissingsamples:
149432539226 Uploaded
florianbegusch
parents:
diff changeset
40 --p-ignore-missing-samples
149432539226 Uploaded
florianbegusch
parents:
diff changeset
41 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
42
4
florianbegusch
parents: 2
diff changeset
43 #if str($pnumberoffeatures):
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
44 --p-number-of-features=$pnumberoffeatures
149432539226 Uploaded
florianbegusch
parents:
diff changeset
45 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
46
149432539226 Uploaded
florianbegusch
parents:
diff changeset
47 --o-visualization=ovisualization
149432539226 Uploaded
florianbegusch
parents:
diff changeset
48 ;
149432539226 Uploaded
florianbegusch
parents:
diff changeset
49 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
149432539226 Uploaded
florianbegusch
parents:
diff changeset
50 && cp -r out/* '$ovisualization.files_path'
149432539226 Uploaded
florianbegusch
parents:
diff changeset
51 && mv '$ovisualization.files_path/index.html' '$ovisualization'
149432539226 Uploaded
florianbegusch
parents:
diff changeset
52 ]]></command>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
53 <inputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
54 <param format="qza,no_unzip.zip" label="--i-biplot: ARTIFACT PCoAResults % Properties('biplot') The principal coordinates matrix to be plotted. [required]" name="ibiplot" optional="False" type="data"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
55 <param label="--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"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
56 <param label="--p-number-of-features: INTEGER Range(1, None) The number of most important features (arrows) to display in the ordination. [default: 5]" name="pnumberoffeatures" optional="True" type="integer" min="1" value="5"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
57
4
florianbegusch
parents: 2
diff changeset
58 <repeat name="m_sample_metadatafile" optional="False" title="--m-sample-metadata-file [required]">
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
59 <param label="--m-sample-metadata-file: (multiple arguments will be merged) The sample metadata. [required]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
149432539226 Uploaded
florianbegusch
parents:
diff changeset
60 </repeat>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
61
4
florianbegusch
parents: 2
diff changeset
62 <repeat name="m_feature_metadatafile" optional="True" title="--m-feature-metadata-file">
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
63 <param label="--m-feature-metadata-file: (multiple arguments will be merged) The feature metadata (useful to manipulate the arrows in the plot). [optional]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
149432539226 Uploaded
florianbegusch
parents:
diff changeset
64 </repeat>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
65
149432539226 Uploaded
florianbegusch
parents:
diff changeset
66 </inputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
67 <outputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
68 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
69 </outputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
70 <help><![CDATA[
149432539226 Uploaded
florianbegusch
parents:
diff changeset
71 Visualize and Interact with Principal Coordinates Analysis Biplot
149432539226 Uploaded
florianbegusch
parents:
diff changeset
72 #################################################################
149432539226 Uploaded
florianbegusch
parents:
diff changeset
73
149432539226 Uploaded
florianbegusch
parents:
diff changeset
74 Generates an interactive ordination biplot where the user can visually
149432539226 Uploaded
florianbegusch
parents:
diff changeset
75 integrate sample and feature metadata.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
76
149432539226 Uploaded
florianbegusch
parents:
diff changeset
77 Parameters
149432539226 Uploaded
florianbegusch
parents:
diff changeset
78 ----------
149432539226 Uploaded
florianbegusch
parents:
diff changeset
79 biplot : PCoAResults % Properties('biplot')
149432539226 Uploaded
florianbegusch
parents:
diff changeset
80 The principal coordinates matrix to be plotted.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
81 sample_metadata : Metadata
149432539226 Uploaded
florianbegusch
parents:
diff changeset
82 The sample metadata
149432539226 Uploaded
florianbegusch
parents:
diff changeset
83 feature_metadata : Metadata, optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
84 The feature metadata (useful to manipulate the arrows in the plot).
149432539226 Uploaded
florianbegusch
parents:
diff changeset
85 ignore_missing_samples : Bool, optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
86 This will suppress the error raised when the coordinates matrix
149432539226 Uploaded
florianbegusch
parents:
diff changeset
87 contains samples that are not present in the metadata. Samples without
149432539226 Uploaded
florianbegusch
parents:
diff changeset
88 metadata are included by setting all metadata values to: "This sample
149432539226 Uploaded
florianbegusch
parents:
diff changeset
89 has no metadata". This flag is only applied if at least one sample is
149432539226 Uploaded
florianbegusch
parents:
diff changeset
90 present in both the coordinates matrix and the metadata.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
91 number_of_features : Int % Range(1, None), optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
92 The number of most important features (arrows) to display in the
149432539226 Uploaded
florianbegusch
parents:
diff changeset
93 ordination.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
94
149432539226 Uploaded
florianbegusch
parents:
diff changeset
95 Returns
149432539226 Uploaded
florianbegusch
parents:
diff changeset
96 -------
149432539226 Uploaded
florianbegusch
parents:
diff changeset
97 visualization : Visualization
149432539226 Uploaded
florianbegusch
parents:
diff changeset
98 ]]></help>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
99 <macros>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
100 <import>qiime_citation.xml</import>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
101 </macros>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
102 <expand macro="qiime_citation"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
103 </tool>