annotate qiime2/qiime_longitudinal_first-differences.xml @ 4:914fa4daf16a draft

Fixes
author florianbegusch
date Wed, 31 Jul 2019 03:06:00 -0400
parents 370e0b6e9826
children de4c22a52df4
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_longitudinal_first-differences" name="qiime longitudinal first-differences" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Compute first differences or difference from baseline between sequential states</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 longitudinal first-differences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --p-state-column="$pstatecolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --p-individual-id-column="$pindividualidcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --p-metric="$pmetric"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #if str($itable) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #if str($preplicatehandling) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --p-replicate-handling=$preplicatehandling
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #if str($pbaseline):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --p-baseline="$pbaseline"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --o-first-differences=ofirstdifferences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 cp ofirstdifferences.qza $ofirstdifferences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <param label="--p-state-column: TEXT Metadata column containing state (time) variable information. [required]" name="pstatecolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <param label="--p-individual-id-column: TEXT Metadata column containing IDs for individual subjects. [required]" name="pindividualidcolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <param label="--p-metric: TEXT Numerical metadata or artifact column to test. [required]" name="pmetric" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[RelativeFrequency] Feature table to optionally use for computing first differences. [optional]" name="itable" optional="True" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <param label="--p-replicate-handling: " name="preplicatehandling" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <option value="error">error</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <option value="random">random</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <option value="drop">drop</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <param label="--p-baseline: NUMBER A value listed in the state-column metadata column against which all other states should be compared. Toggles calculation of static differences instead of first differences (which are calculated if no value is given for baseline). If a 'baseline' value is provided, sample differences at each state are compared against the baseline state, instead of the previous state. Must be a value listed in the state-column. [optional]" name="pbaseline" optional="True" type="float"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55
4
florianbegusch
parents: 0
diff changeset
56 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file [required]">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <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" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <data format="qza" label="${tool.name} on ${on_string}: firstdifferences.qza" name="ofirstdifferences"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 Compute first differences or difference from baseline between sequential states
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 ###############################################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 Calculates first differences in "metric" between sequential states for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 samples collected from individual subjects sampled repeatedly at two or
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 more states. First differences can be performed on a metadata column
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 (including artifacts that can be input as metadata) or a feature in a
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 feature table. Outputs a data series of first differences for each
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 individual subject at each sequential pair of states, labeled by the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 SampleID of the second state (e.g., paired differences between time 0 and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 time 1 would be labeled by the SampleIDs at time 1). This file can be used
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 as input to linear mixed effects models or other longitudinal or diversity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 methods to compare changes in first differences across time or among groups
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 of subjects. Also supports differences from baseline (or other static
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 comparison state) by setting the "baseline" parameter.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 Sample metadata file containing individual_id_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 state_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 Metadata column containing state (time) variable information.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 individual_id_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 Metadata column containing IDs for individual subjects.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 metric : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 Numerical metadata or artifact column to test.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 replicate_handling : Str % Choices('error', 'random', 'drop'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 Choose how replicate samples are handled. If replicates are detected,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 "error" causes method to fail; "drop" will discard all replicated
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 samples; "random" chooses one representative at random from among
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 replicates.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 baseline : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 A value listed in the state_column metadata column against which all
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 other states should be compared. Toggles calculation of static
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 differences instead of first differences (which are calculated if no
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 value is given for baseline). If a "baseline" value is provided, sample
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 differences at each state are compared against the baseline state,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 instead of the previous state. Must be a value listed in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 state_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 table : FeatureTable[RelativeFrequency], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 Feature table to optionally use for computing first differences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 first_differences : SampleData[FirstDifferences]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 Series of first differences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 </tool>