annotate qiime2/qiime_emperor_biplot.xml @ 1:255f48db74f8 draft

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