annotate qiime2/qiime_gneiss_lme-regression.xml @ 8:d66c7509e8f9 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:57:53 -0400
parents 914fa4daf16a
children f190567fe3f6
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_gneiss_lme-regression" name="qiime gneiss lme-regression" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Simplicial Linear mixed effects regression</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 gneiss lme-regression
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-tree=$itree
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --p-formula="$pformula"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 --p-groups="$pgroups"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 && mv '$ovisualization.files_path/index.html' '$ovisualization';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 <inputs>
370e0b6e9826 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 with mixed effect will be performed. [required]" name="itable" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 <param format="qza,no_unzip.zip" label="--i-tree: ARTIFACT A hierarchy of feature identifiers where each tip Hierarchy corresponds 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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 <param label="--p-formula: TEXT Statistical formula specifying the statistical model. In other words, a list of the metadata categories that will be used in the linear mixed effect model, typically separated by '+'. For more information see https://patsy.readthedocs.io/en/latest/API-reference.ht ml [required]" name="pformula" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 <param label="--p-groups: TEXT [required]" name="pgroups" optional="False" type="text"/>
4
florianbegusch
parents: 0
diff changeset
39
florianbegusch
parents: 0
diff changeset
40 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file [required]">
florianbegusch
parents: 0
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" />
florianbegusch
parents: 0
diff changeset
42 </repeat>
florianbegusch
parents: 0
diff changeset
43
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 Simplicial Linear mixed effects regression
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 ##########################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 Build and run linear mixed effects model on balances. Use LME over OLS when
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 you have repeated measurements such as (timeseries).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 table : FeatureTable[Balance]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 The feature table containing the samples in which simplicial regression
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 with mixed effect will be performed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 tree : Hierarchy
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 A hierarchy of feature identifiers where each tip corresponds to the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 feature identifiers in the table. This tree can contain tip ids that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 are not present in the table, but all feature ids in the table must be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 present in this tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 Metadata information that contains the covariates of interest.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 formula : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 Statistical formula specifying the statistical model. In other words, a
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 list of the metadata categories that will be used in the linear mixed
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 effect model, typically separated by "+". For more information see
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 https://patsy.readthedocs.io/en/latest/API-reference.html
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 groups : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 \
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 </tool>