annotate qiime2/qiime_gneiss_ols-regression.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_gneiss_ols-regression" name="qiime gneiss ols-regression" version="2019.4">
149432539226 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Simplicial Ordinary Least Squares Regression</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 gneiss ols-regression
149432539226 Uploaded
florianbegusch
parents:
diff changeset
9
149432539226 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
149432539226 Uploaded
florianbegusch
parents:
diff changeset
11 --i-tree=$itree
149432539226 Uploaded
florianbegusch
parents:
diff changeset
12 --p-formula="$pformula"
149432539226 Uploaded
florianbegusch
parents:
diff changeset
13
149432539226 Uploaded
florianbegusch
parents:
diff changeset
14
149432539226 Uploaded
florianbegusch
parents:
diff changeset
15 #if $input_files_mmetadatafile:
149432539226 Uploaded
florianbegusch
parents:
diff changeset
16 #def list_dict_to_string(list_dict):
149432539226 Uploaded
florianbegusch
parents:
diff changeset
17 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
149432539226 Uploaded
florianbegusch
parents:
diff changeset
18 #for d in list_dict[1:]:
149432539226 Uploaded
florianbegusch
parents:
diff changeset
19 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
149432539226 Uploaded
florianbegusch
parents:
diff changeset
20 #end for
149432539226 Uploaded
florianbegusch
parents:
diff changeset
21 #return $file_list
149432539226 Uploaded
florianbegusch
parents:
diff changeset
22 #end def
149432539226 Uploaded
florianbegusch
parents:
diff changeset
23 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
149432539226 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
25
149432539226 Uploaded
florianbegusch
parents:
diff changeset
26
149432539226 Uploaded
florianbegusch
parents:
diff changeset
27 --o-visualization=ovisualization
149432539226 Uploaded
florianbegusch
parents:
diff changeset
28 ;
149432539226 Uploaded
florianbegusch
parents:
diff changeset
29
149432539226 Uploaded
florianbegusch
parents:
diff changeset
30 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
149432539226 Uploaded
florianbegusch
parents:
diff changeset
31 && cp -r out/* '$ovisualization.files_path'
149432539226 Uploaded
florianbegusch
parents:
diff changeset
32 && mv '$ovisualization.files_path/index.html' '$ovisualization';
149432539226 Uploaded
florianbegusch
parents:
diff changeset
33 ]]></command>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
34 <inputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
35 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Balance] The feature table containing the samples in which simplicial regression will be performed. [required]" name="itable" optional="False" type="data"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
36 <param format="qza,no_unzip.zip" label="--i-tree: ARTIFACT A hierarchy of feature identifiers where each Hierarchy tipcorresponds to the feature identifiers in the table. This tree can contain tip ids that are not present in the table, but all feature ids in the table must be present in this tree. [required]" name="itree" optional="False" type="data"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
37 <param label="--p-formula: TEXT Formula specifying the statistical model. In other words, a list of the metadata categories that will be used in the regression model, typically separated by '+'. For more information see https://patsy.readthedocs.io/en/latest/API-reference.html [required]" name="pformula" optional="False" type="text"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
38
149432539226 Uploaded
florianbegusch
parents:
diff changeset
39
4
florianbegusch
parents: 2
diff changeset
40 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file [required]">
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
41 <param label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [optional]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
149432539226 Uploaded
florianbegusch
parents:
diff changeset
42 </repeat>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
43 </inputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
44 <outputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
45 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
46 </outputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
47 <help><![CDATA[
149432539226 Uploaded
florianbegusch
parents:
diff changeset
48 Simplicial Ordinary Least Squares Regression
149432539226 Uploaded
florianbegusch
parents:
diff changeset
49 ############################################
149432539226 Uploaded
florianbegusch
parents:
diff changeset
50
149432539226 Uploaded
florianbegusch
parents:
diff changeset
51 Perform linear regression on balances. This will tell youhow much
149432539226 Uploaded
florianbegusch
parents:
diff changeset
52 variability is explained by metadata categories in your formula.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
53
149432539226 Uploaded
florianbegusch
parents:
diff changeset
54 Parameters
149432539226 Uploaded
florianbegusch
parents:
diff changeset
55 ----------
149432539226 Uploaded
florianbegusch
parents:
diff changeset
56 table : FeatureTable[Balance]
149432539226 Uploaded
florianbegusch
parents:
diff changeset
57 The feature table containing the samples in which simplicial regression
149432539226 Uploaded
florianbegusch
parents:
diff changeset
58 will be performed.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
59 tree : Hierarchy
149432539226 Uploaded
florianbegusch
parents:
diff changeset
60 A hierarchy of feature identifiers where each tipcorresponds to the
149432539226 Uploaded
florianbegusch
parents:
diff changeset
61 feature identifiers in the table. This tree can contain tip ids that
149432539226 Uploaded
florianbegusch
parents:
diff changeset
62 are not present in the table, but all feature ids in the table must be
149432539226 Uploaded
florianbegusch
parents:
diff changeset
63 present in this tree.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
64 metadata : Metadata
149432539226 Uploaded
florianbegusch
parents:
diff changeset
65 Metadata information that contains the covariates of interest.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
66 formula : Str
149432539226 Uploaded
florianbegusch
parents:
diff changeset
67 Formula specifying the statistical model. In other words, a list of the
149432539226 Uploaded
florianbegusch
parents:
diff changeset
68 metadata categories that will be used in the regression model,
149432539226 Uploaded
florianbegusch
parents:
diff changeset
69 typically separated by "+". For more information see
149432539226 Uploaded
florianbegusch
parents:
diff changeset
70 https://patsy.readthedocs.io/en/latest/API-reference.html
149432539226 Uploaded
florianbegusch
parents:
diff changeset
71
149432539226 Uploaded
florianbegusch
parents:
diff changeset
72 Returns
149432539226 Uploaded
florianbegusch
parents:
diff changeset
73 -------
149432539226 Uploaded
florianbegusch
parents:
diff changeset
74 visualization : Visualization
149432539226 Uploaded
florianbegusch
parents:
diff changeset
75 ]]></help>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
76 <macros>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
77 <import>qiime_citation.xml</import>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
78 </macros>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
79 <expand macro="qiime_citation"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
80 </tool>