0
|
1 <tool id="secimtools_ttest" name="T-Test (Paired or Unpaired)" version="@WRAPPER_VERSION@">
|
|
2 <description>on features.</description>
|
|
3 <macros>
|
|
4 <import>macros.xml</import>
|
|
5 </macros>
|
|
6 <expand macro="requirements" />
|
|
7 <command detect_errors="exit_code"><![CDATA[
|
|
8 ttest.py
|
|
9 --input $input
|
|
10 --design $design
|
|
11 --uniqueID $uniqueID
|
|
12 --group $group
|
|
13 --pairing $pairing
|
|
14 --summaries $summaries
|
|
15 --flags $flags
|
|
16 --volcano $volcano
|
|
17 #if $order
|
|
18 --order $order
|
|
19 #end if
|
|
20 ]]></command>
|
|
21 <inputs>
|
|
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."/>
|
|
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."/>
|
|
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."/>
|
|
25 <param name="group" type="text" size="30" label="Group/Treatment" help="Name of the column in your Design File that contains group classifications."/>
|
|
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.">
|
|
27 <option value="unpaired" selected="true">Unpaired (Independent Samples)</option>
|
|
28 <option value="paired" selected="true">Paired (Dependent Samples)</option>
|
|
29 </param>
|
|
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."/>
|
|
31 </inputs>
|
|
32 <outputs>
|
|
33 <data format="tabular" name="summaries" label="${tool.name} on ${on_string}: Summaries that include p-values and mean differences."/>
|
|
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. "/>
|
|
35 <data format="pdf" name="volcano" label="${tool.name} on ${on_string}: Volcano plots for the differences."/>
|
|
36 </outputs>
|
|
37 <tests>
|
|
38 <test>
|
|
39 <param name="input" value="ST000006_data.tsv"/>
|
|
40 <param name="design" value="ST000006_design.tsv"/>
|
|
41 <param name="uniqueID" value="Retention_Index" />
|
|
42 <param name="group" value="White_wine_type_and_source" />
|
|
43 <param name="pairing" value="unpaired" />
|
|
44 <output name="summaries" file="ST000006_ttest_select_unpaired_summary.tsv" />
|
|
45 <output name="flags" file="ST000006_ttest_select_unpaired_flags.tsv" />
|
|
46 <output name="volcano" file="ST000006_ttest_select_unpaired_volcano.pdf" compare="sim_size" delta="10000"/>
|
|
47 </test>
|
|
48 </tests>
|
|
49 <help><![CDATA[
|
|
50
|
|
51 @TIP_AND_WARNING@
|
|
52
|
|
53 **Tool Description**
|
|
54
|
|
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).
|
|
56 The user selects which test (paired or unpaired) to perform.
|
|
57
|
|
58 In an unpaired t-test, the samples within and between groups are independent.
|
|
59 The test is performed for all pairs of conditions specified using the Group/Treatment field.
|
|
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.
|
|
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.
|
|
62
|
|
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.
|
|
64 Here, the difference between the measurements for the pairs is calculated.
|
|
65 To ensure that the differences are taken in the same order across all pairs, the Group/Treatment variable is required.
|
|
66 The differences will be calculated beween the groups in the order that the groups appear in the Design File.
|
|
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.
|
|
68
|
|
69 --------------------------------------------------------------------------------
|
|
70
|
|
71 **Input**
|
|
72
|
|
73 - Two input datasets are required.
|
|
74
|
|
75
|
|
76 @WIDE@
|
|
77
|
|
78 **NOTE:** The sample IDs must match the sample IDs in the Design File
|
|
79 (below). Extra columns will automatically be ignored.
|
|
80
|
|
81 @METADATA@
|
|
82
|
|
83 @UNIQID@
|
|
84
|
|
85 **Group/Treatment**
|
|
86
|
|
87 - List with the name of the column the Design File that contains group classifications.
|
|
88
|
|
89 **Pairing ID**
|
|
90
|
|
91 - Name of the column in your Design File that contains Pairing IDs. An example is given below:
|
|
92
|
|
93 +----------+--------+--------+
|
|
94 | sampleID | group | pairID |
|
|
95 +==========+========+========+
|
|
96 | sample1 | g1 | p1 |
|
|
97 +----------+--------+--------+
|
|
98 | sample2 | g1 | p2 |
|
|
99 +----------+--------+--------+
|
|
100 | sample3 | g1 | p3 |
|
|
101 +----------+--------+--------+
|
|
102 | sample4 | g2 | p1 |
|
|
103 +----------+--------+--------+
|
|
104 | sample5 | g2 | p2 |
|
|
105 +----------+--------+--------+
|
|
106 | sample6 | g2 | p3 |
|
|
107 +----------+--------+--------+
|
|
108 | ... | ... | ... |
|
|
109 +----------+--------+--------+
|
|
110
|
|
111
|
|
112
|
|
113 --------------------------------------------------------------------------------
|
|
114
|
|
115 **Output**
|
|
116
|
|
117 The tool outputs 3 files:
|
|
118
|
|
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.
|
|
120 (2) a TSV file with an indicator flag = 1 if the difference between the groups is statistically significant using provided α levels.
|
|
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).
|
|
122
|
|
123 ]]></help>
|
|
124 <expand macro="citations"/>
|
|
125 </tool>
|