annotate secimtools/ttest.xml @ 0:b54326490b4d draft

Upload 21.3.4.2 release
author malex
date Mon, 08 Mar 2021 20:55:03 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
1 <tool id="secimtools_ttest" name="T-Test (Paired or Unpaired)" version="@WRAPPER_VERSION@">
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
2 <description>on features.</description>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
3 <macros>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
4 <import>macros.xml</import>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
5 </macros>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
6 <expand macro="requirements" />
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
8 ttest.py
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
9 --input $input
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
10 --design $design
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
11 --uniqueID $uniqueID
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
12 --group $group
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
13 --pairing $pairing
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
14 --summaries $summaries
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
15 --flags $flags
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
16 --volcano $volcano
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
17 #if $order
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
18 --order $order
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
19 #end if
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
20 ]]></command>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
21 <inputs>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
22 <param name="input" type="data" format="tabular" label="Wide Dataset" help="Input dataset in wide format and tab separated. If file is not tab separated see TIP below."/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
23 <param name="design" type="data" format="tabular" label="Design File" help="Design file tab separated. Note you need a 'sampleID' column. If not tab separated see TIP below."/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
24 <param name="uniqueID" type="text" size="30" value="" label="Unique Feature ID" help="Name of the column in your Wide Dataset that has unique Feature IDs."/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
25 <param name="group" type="text" size="30" label="Group/Treatment" help="Name of the column in your Design File that contains group classifications."/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
26 <param name="pairing" size="30" display="radio" type="select" value="unpaired" label="Select Test" help="Select either paired (dependent samples) or unpaired (independent samples) tests.">
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
27 <option value="unpaired" selected="true">Unpaired (Independent Samples)</option>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
28 <option value="paired" selected="true">Paired (Dependent Samples)</option>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
29 </param>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
30 <param name="order" type="text" value="" size="30" label="Pairing ID" help="Name of the column in your Design File that contains Pairing IDs. Ignored for Unpaired (Independent Samples) test."/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
31 </inputs>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
32 <outputs>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
33 <data format="tabular" name="summaries" label="${tool.name} on ${on_string}: Summaries that include p-values and mean differences."/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
34 <data format="tabular" name="flags" label="${tool.name} on ${on_string}: Flags that include 0.01, 0.05 and 0.10 significance levels for the differences. "/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
35 <data format="pdf" name="volcano" label="${tool.name} on ${on_string}: Volcano plots for the differences."/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
36 </outputs>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
37 <tests>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
38 <test>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
39 <param name="input" value="ST000006_data.tsv"/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
40 <param name="design" value="ST000006_design.tsv"/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
41 <param name="uniqueID" value="Retention_Index" />
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
42 <param name="group" value="White_wine_type_and_source" />
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
43 <param name="pairing" value="unpaired" />
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
44 <output name="summaries" file="ST000006_ttest_select_unpaired_summary.tsv" />
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
45 <output name="flags" file="ST000006_ttest_select_unpaired_flags.tsv" />
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
46 <output name="volcano" file="ST000006_ttest_select_unpaired_volcano.pdf" compare="sim_size" delta="10000"/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
47 </test>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
48 </tests>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
49 <help><![CDATA[
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
50
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
51 @TIP_AND_WARNING@
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
52
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
53 **Tool Description**
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
54
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
55 The tool performs a two-sided t-test for two groups of dependent samples (paired or dependent t-test) or multiple (two or more) groups of independent samples (unpaired or independent t-test).
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
56 The user selects which test (paired or unpaired) to perform.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
57
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
58 In an unpaired t-test, the samples within and between groups are independent.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
59 The test is performed for all pairs of conditions specified using the Group/Treatment field.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
60 For example, if there are three treatment conditions (Control, Time1 and Time2) then t-tests will be performed for: (i) Control vs Time1, (ii) Control vs Time2, and (iii) Time1 vs Time2.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
61 Note that this will give slightly different results than the contrast in an ANOVA because the ANOVA uses all groups to estimate the error.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
62
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
63 A paired t-test can be performed for pairs of treatment conditions where sample pairs are known and specified by the user in the Pairing ID field.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
64 Here, the difference between the measurements for the pairs is calculated.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
65 To ensure that the differences are taken in the same order across all pairs, the Group/Treatment variable is required.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
66 The differences will be calculated beween the groups in the order that the groups appear in the Design File.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
67 The Pairing ID specifies which samples are paired. A two sided t-test will be performed for the test that the difference is zero.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
68
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
69 --------------------------------------------------------------------------------
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
70
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
71 **Input**
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
72
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
73 - Two input datasets are required.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
74
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
75
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
76 @WIDE@
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
77
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
78 **NOTE:** The sample IDs must match the sample IDs in the Design File
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
79 (below). Extra columns will automatically be ignored.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
80
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
81 @METADATA@
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
82
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
83 @UNIQID@
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
84
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
85 **Group/Treatment**
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
86
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
87 - List with the name of the column the Design File that contains group classifications.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
88
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
89 **Pairing ID**
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
90
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
91 - Name of the column in your Design File that contains Pairing IDs. An example is given below:
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
92
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
93 +----------+--------+--------+
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
94 | sampleID | group | pairID |
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
95 +==========+========+========+
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
96 | sample1 | g1 | p1 |
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
97 +----------+--------+--------+
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
98 | sample2 | g1 | p2 |
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
99 +----------+--------+--------+
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
100 | sample3 | g1 | p3 |
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
101 +----------+--------+--------+
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
102 | sample4 | g2 | p1 |
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
103 +----------+--------+--------+
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
104 | sample5 | g2 | p2 |
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
105 +----------+--------+--------+
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
106 | sample6 | g2 | p3 |
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
107 +----------+--------+--------+
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
108 | ... | ... | ... |
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
109 +----------+--------+--------+
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
110
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
111
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
112
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
113 --------------------------------------------------------------------------------
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
114
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
115 **Output**
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
116
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
117 The tool outputs 3 files:
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
118
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
119 (1) a TSV file with the results table containing p-values for each test and the corresponding differences between the means for comparisons between the groups.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
120 (2) a TSV file with an indicator flag = 1 if the difference between the groups is statistically significant using provided α levels.
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
121 (3) a PDF file with volcano plots visual inspection of the differences between group means and p-values. The red dashed line in volcano plot(s) corresponds to a p-value = 0.01 cutoff (2 on the negative log base 10 scale).
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
122
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
123 ]]></help>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
124 <expand macro="citations"/>
b54326490b4d Upload 21.3.4.2 release
malex
parents:
diff changeset
125 </tool>