annotate edgeR_Design_from_Expression_Matrix.xml @ 84:ddcc677fb13d draft

Uploaded
author yhoogstrate
date Wed, 19 Nov 2014 09:45:17 -0500
parents b2738b4d7c8c
children 46745f5666ac
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
30
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
79
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
2 <tool id="design_from_expression_matrix" name="edgeR: Design- from Expression matrix" version="1.0.0.a">
30
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
3 <description>Create design- from an expression matrix</description>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
4
79
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
5 <requirements>
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
6 <requirement type="package" version="1.0.0">design_matrix_creator</requirement>
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
7 </requirements>
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
8
30
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
9 <command interpreter="python">
79
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
10 design_matrix_creator
30
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
11 -c $expression_matrix
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
12
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
13 #set $unique_columns = []
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
14 #for $factor in $treatments:
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
15 #for $level in $factor.rep_factorLevel:
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
16 #for $val in $level.factorIndex.value:
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
17 #if str($val) not in $unique_columns:
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
18 #set $unique_columns = $unique_columns + [str($val)]
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
19 #end if
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
20 #end for
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
21 #end for
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
22 #end for
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
23
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
24 #set $unique_columns = " ".join(unique_columns)
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
25 -s $unique_columns
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
26
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
27 -t
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
28 #for $factor in $treatments:
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
29 #set $factor_str = str($factor.name).encode('base64').replace('\n','')
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
30
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
31 #for $level in $factor.rep_factorLevel:
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
32 #set $factor_str = $factor_str+":"+str($level.factorLevel).encode('base64').replace('\n','')+":"+",".join([str(x).strip() for x in $level.factorIndex.value])
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
33 #end for
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
34
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
35 $factor_str
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
36 #end for
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
37
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
38 #if $choose_blocking.choice == "true"
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
39 -b
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
40 #for blocking in $choose_blocking.blocking_repeat:
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
41 #set $blocking_str = str($blocking.blocking_name).encode('base64').replace('\n','')
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
42
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
43 #for $block_iter in $blocking.block:
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
44 #set $block_str = ",".join([str(x).strip() for x in $block_iter.block_index.value])
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
45 #set $blocking_str = $blocking_str+":"+$block_str
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
46 #end for
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
47
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
48 $blocking_str
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
49 #end for
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
50 #end if
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
51
48
34cd814f2327 Uploaded
yhoogstrate
parents: 30
diff changeset
52 -o $design_matrix
30
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
53 </command>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
54
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
55 <inputs>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
56 <param format="tabular" name="expression_matrix" type="data" label="Expression matrix (read counts)" help="You can create a count matrix with the tool" />
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
57
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
58 <repeat name="treatments" title="Factor/Condition" min="1">
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
59 <param name="name" type="text" value="FactorName" label="Specify a name for the factor / condition" help="e.g. 'Tumor vs. Normal', 'Timepoint' or 'DiseaseState'. Field must be non-numerical, preferably only letters!!" />
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
60 <repeat name="rep_factorLevel" title="Factor level" min="1">
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
61 <param name="factorLevel" type="text" value="FactorLevel" label="Specify a condition" help="e.g. Tumor or Normal; Treated, untreaded or placebo. Field must be non-numerical, preferably only letters!!" />
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
62 <param name="factorIndex" numerical="false" use_header_names="true" label="Select columns that are associated with this factor level" type="data_column" data_ref="expression_matrix" multiple="true" size="120" display="checkboxes">
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
63 <validator type="no_options" message="Please select at least one column." />
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
64 </param>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
65 </repeat>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
66 </repeat>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
67
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
68 <conditional name="choose_blocking">
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
69 <param name="choice" type="select" label="Define blocking (paired or grouped samples)" help="e.g. to remove batch effects" >
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
70 <option value="false">No</option>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
71 <option value="true">Yes</option>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
72 </param>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
73 <when value="false" />
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
74 <when value="true">
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
75 <repeat name="blocking_repeat" title="Blocking condition" min="1">
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
76 <param name="blocking_name" type="text" value="" label="Specify a name for a blocking condition" help="e.g.'Patients' or 'Batches'" />
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
77 <repeat name="block" title="Block" min="2">
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
78 <param name="block_index" label="Select columns that are associated with this factor level" type="data_column" data_ref="expression_matrix" numerical="True" multiple="true" use_header_names="true" size="120" display="checkboxes">
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
79 <validator type="no_options" message="Please select at least one column." />
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
80 </param>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
81 </repeat>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
82 </repeat>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
83 </when>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
84 </conditional>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
85 </inputs>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
86
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
87 <outputs>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
88 <data format="tabular" name="design_matrix" label="Design matrix" />
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
89 </outputs>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
90
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
91 <help>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
92 edgeR: Design- from Expression matrix
79
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
93 #####################################
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
94
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
95 Overview
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
96 --------
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
97
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
98 Create a design matrix by selecting the desired patients from an
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
99 expression matrix.
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
100
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
101 Input
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
102 -----
30
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
103
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
104 **References**
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
105
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
106 The test data is coming from: doi: 10.1093/bioinformatics/btt688.
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
107 http://www.ncbi.nlm.nih.gov/pubmed/24319002
79
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
108
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
109 Contact
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
110 -------
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
111
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
112 The tool wrapper has been written by Youri Hoogstrate from the Erasmus
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
113 Medical Center (Rotterdam, Netherlands) on behalf of the Translational
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
114 Research IT (TraIT) project:
83
b2738b4d7c8c Uploaded
yhoogstrate
parents: 79
diff changeset
115
79
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
116 http://www.ctmm.nl/en/programmas/infrastructuren/traitprojecttranslationeleresearch
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
117
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
118 More tools by the Translational Research IT (TraIT) project can be found
c86f1f86b3c1 Uploaded
yhoogstrate
parents: 48
diff changeset
119 in the following toolsheds:
83
b2738b4d7c8c Uploaded
yhoogstrate
parents: 79
diff changeset
120
b2738b4d7c8c Uploaded
yhoogstrate
parents: 79
diff changeset
121 http://toolshed.dtls.nl/
b2738b4d7c8c Uploaded
yhoogstrate
parents: 79
diff changeset
122
b2738b4d7c8c Uploaded
yhoogstrate
parents: 79
diff changeset
123 http://toolshed.g2.bx.psu.edu
b2738b4d7c8c Uploaded
yhoogstrate
parents: 79
diff changeset
124
b2738b4d7c8c Uploaded
yhoogstrate
parents: 79
diff changeset
125 http://testtoolshed.g2.bx.psu.edu/
30
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
126 </help>
171f3cf6233d Uploaded
yhoogstrate
parents:
diff changeset
127 </tool>