annotate metascreenPre.xml @ 6:f6e6b6914b48 draft

Uploaded
author sigven
date Wed, 21 Dec 2022 23:22:27 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
1 <tool id="metascreenPre" name="metascreen: pre-experimental" version="0.2.6">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
2 <description>Setup of drug combination screens</description>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
3 <requirements>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
4 <container type="docker">sigven/metascreen:0.2.1</container>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
5 </requirements>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
6 <command detect_errors="aggressive"><![CDATA[
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
7 ln -f -s $input_data.list_of_drugs "$input_data.list_of_drugs.element_identifier" &&
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
8 #set drugs_csv = './' + str($input_data.list_of_drugs.element_identifier)
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
9
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
10 ln -f -s $input_data.list_of_volumes "$input_data.list_of_volumes.element_identifier" &&
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
11 #set volumes_csv = './' + str($input_data.list_of_volumes.element_identifier)
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
12
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
13 ln -f -s $input_data.list_of_doses "$input_data.list_of_doses.element_identifier" &&
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
14 #set doses_csv = './' + str($input_data.list_of_doses.element_identifier)
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
15
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
16 ln -f -s $input_data.list_of_ctrls "$input_data.list_of_ctrls.element_identifier" &&
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
17 #set ctrls_csv = './' + str($input_data.list_of_ctrls.element_identifier)
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
18
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
19 ln -f -s $input_data.list_of_stock_cons "$input_data.list_of_stock_cons.element_identifier" &&
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
20 #set stock_cons_csv = './' + str($input_data.list_of_stock_cons.element_identifier)
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
21
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
22 #for $pmap in $input_data.platemaps
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
23 ln -f -s '$pmap' '$pmap.element_identifier';
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
24 #end for
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
25
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
26
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
27 #set excluded_well_ids_file = ''
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
28 #if $dispensing_options.well_exclusion.exclude_wells
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
29 echo 'DUMMY_WELL' > excl_well_ids.csv &&
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
30 echo $dispensing_options.well_exclusion.well_ids | sed 's/__cn__/\n/g' >> excl_well_ids.csv &&
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
31 #set excluded_well_ids_file = './excl_well_ids.csv'
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
32 #end if
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
33
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
34 R -e 'suppressPackageStartupMessages(library(metascreen));
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
35
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
36 custom_excluded_wells = NULL;
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
37 #if $excluded_well_ids_file
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
38 custom_excluded_wells = readr::read_csv(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
39 "$excluded_well_ids_file", show_col_types = F);
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
40 custom_excluded_wells = custom_excluded_wells[[1]];
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
41 #end if
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
42
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
43 list_of_drugs_raw <- read.csv(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
44 file = "$drugs_csv",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
45 check.names = FALSE,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
46 na.strings = "",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
47 dec = ".", encoding = "UTF-8");
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
48 list_of_volumes_raw <- read.csv(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
49 file = "$volumes_csv",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
50 check.names = FALSE,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
51 na.strings = "",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
52 dec = ".", encoding = "UTF-8");
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
53 list_of_doses_raw <- read.csv(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
54 file = "$doses_csv",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
55 check.names = FALSE,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
56 na.strings = "",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
57 dec = ".", encoding = "UTF-8");
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
58 list_of_controls_raw <- read.csv(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
59 file = "$ctrls_csv",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
60 check.names = FALSE,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
61 na.strings = "",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
62 dec = ".", encoding = "UTF-8");
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
63 list_of_stock_cons_raw <- read.csv(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
64 file = "$stock_cons_csv",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
65 check.names = FALSE,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
66 na.strings = "",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
67 dec = ".", encoding = "UTF-8");
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
68
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
69 listofDoses <-
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
70 metascreen::generateListofDoses(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
71 list_of_doses_raw,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
72 .dropCol = TRUE);
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
73
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
74
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
75 sourcePlate = data.frame();
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
76 #for $pmap in $input_data.platemaps
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
77
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
78 sourcePlate = dplyr::bind_rows(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
79 sourcePlate,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
80 metascreen::importPlateMap(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
81 "$pmap.element_identifier",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
82 .fileFormat = "PlateMap",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
83 .sourcePlateConv = TRUE));
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
84 #end for
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
85
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
86
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
87
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
88 combine_doses = c(1:min(unique(table(listofDoses[,"Drug"]))));
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
89 exclude_outer_wells = FALSE;
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
90
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
91 #if $dispensing_options.well_exclusion.exclude_wells
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
92 exclude_outer_wells = $dispensing_options.well_exclusion.outer_wells;
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
93 #end if
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
94
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
95 #if $combination_options.combo_design.type_combination == "all"
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
96 #if $combination_options.combo_design.inner_dosing
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
97 combine_doses = c(2:(min(unique(table(listofDoses[,"Drug"])))-1));
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
98 #end if
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
99 #end if
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
100
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
101 add_untreated = NULL;
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
102 #if $dispensing_options.add_untreated.untreated
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
103 add_untreated = list(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
104 name = "$dispensing_options.add_untreated.untreated_name",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
105 replicates = $dispensing_options.add_untreated.untreated_replicates);
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
106 #end if
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
107
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
108
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
109 listofExWells <-
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
110 metascreen::excludeWells(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
111 plateType = $input_data.plateformat,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
112 wells = custom_excluded_wells,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
113 outer.wells = exclude_outer_wells);
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
114
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
115
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
116 listofCombinations <-
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
117 metascreen::combineDrugs(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
118 listofDoses,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
119 .combineDoses = combine_doses,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
120 .noReplicates = $combination_options.num_replicates,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
121 .drugRepAttrib = "$combination_options.combo_design.type_combination");
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
122
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
123
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
124 dispensingData <-
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
125 metascreen::generateDispensingData(
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
126 listofCombinations,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
127 list_of_drugs_raw,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
128 listofDoses,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
129 list_of_volumes_raw,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
130 list_of_controls_raw,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
131 list_of_stock_cons_raw,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
132 sourcePlate,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
133 listofExWells,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
134 .ctrlReplicates = $dispensing_options.num_control_replicates,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
135 .addUntreated = add_untreated,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
136 .finalWellVolume = $dispensing_options.well_volume,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
137 .plateFormat = $input_data.plateformat,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
138 .destinationPlateID = "$dispensing_options.dest_plate_ID",
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
139 .randomizeDispensing = $dispensing_options.randomise_dispensing,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
140 .probeDispensing = $dispensing_options.probe_dispensing);
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
141
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
142
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
143 df = as.data.frame(dispensingData[["output"]]);
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
144 readr::write_tsv(listofCombinations,file="$doseComb",col_names=T, quote="none");
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
145 readr::write_tsv(df,file="$dispensingDF", col_names = T, quote = "none");' 2>&1
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
146
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
147 ]]></command>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
148 <inputs>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
149
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
150 <section name="input_data" title="User-defined input files - see below for strict formatting requirements" expanded="true">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
151 <param name="list_of_doses" type="data" format="txt" label="List of drug doses (CSV)" multiple="false"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
152 <param name="list_of_drugs" type="data" format="txt" label="List of drugs (CSV)" multiple="false"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
153 <param name="list_of_volumes" type="data" format="txt" label="List of volumes (CSV)" multiple="false"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
154 <param name="list_of_ctrls" type="data" format="txt" label="List of controls (CSV)" multiple="false"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
155 <param name="list_of_stock_cons" type="data" format="txt" label="List of stock concentrations (CSV)" multiple="false"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
156 <param name="platemaps" type="data" format="xml" label="PlateMap file (XML)" multiple="true"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
157 <!--param name="convert_platemap_format" type="boolean" label="Convert platemap to a source plate format" truevalue="T" falsevalue="F" checked="false"/-->
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
158 <param name="plateformat" type="select" label="Plate format" display="radio" multiple="false">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
159 <option value="6">6</option>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
160 <option value="12">12</option>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
161 <option value="24">24</option>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
162 <option value="48">48</option>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
163 <option value="96">96</option>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
164 <option value="384">384</option>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
165 <option value="1536">1536</option>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
166 </param>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
167 </section>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
168
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
169 <section name="combination_options" title="Options - drug combination design" expanded="true">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
170 <conditional name="combo_design">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
171 <param name="type_combination" type="select" display="radio" multiple="false" label="Type of dose combinations">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
172 <option value="all">All - both single treatments and combination treatments</option>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
173 <option value="single">Single - only single treatments</option>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
174 </param>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
175 <when value="all">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
176 <param name="inner_dosing" type="boolean" label="Exclude lowest and highest dose (inner dosing only)" truevalue="T" falsevalue="F" checked="false"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
177 </when>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
178 </conditional>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
179 <param type="integer" name="num_replicates" label="Number of replicates for each dose combination" value="3" min="1" max="20"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
180 </section>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
181 <section name="dispensing_options" title="Options - dispensing layout" expanded="true">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
182 <!--param name="out_dir" type="text" size="25" label="Dispensing files" value="dispFiles" /-->
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
183 <conditional name="well_exclusion">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
184 <param name="exclude_wells" type="boolean" label="Exclusion of wells" truevalue="T" falsevalue="F" checked="false"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
185 <when value="T">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
186 <param name="well_ids" type="text" label="Custom set of well identifiers to exclude (one per line):" area="true"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
187 <param name="outer_wells" type="boolean" label="Exclude all outer wells" truevalue="T" falsevalue="F" checked="true"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
188 </when>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
189 </conditional>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
190 <param name="num_control_replicates" type="integer" label="Number of control replicates" value="3" min="1" max="10"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
191 <param name="well_volume" type="integer" label="Final well volume" value="5" min="1" max="500"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
192 <param name="randomise_dispensing" type="boolean" label="Randomise dispensing" truevalue="T" falsevalue="F" checked="true"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
193 <param name="probe_dispensing" type="boolean" label="Probe dispensing" truevalue="T" falsevalue="F" checked="false"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
194 <param name="dest_plate_ID" type="text" value="PLATE_012" label="A unique destination plate ID - for destination plate barcode"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
195 <conditional name="add_untreated">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
196 <param name="untreated" type="boolean" label="Add untreated" truevalue="T" falsevalue="F" checked="true"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
197 <when value="T">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
198 <param name="untreated_name" type="text" label="Identifier (name) for untreated" value="Untreated"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
199 <param name="untreated_replicates" type="integer" label="Number of untreated replicates" value="5" min="1" max="500"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
200 </when>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
201 </conditional>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
202
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
203 </section>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
204 </inputs>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
205 <outputs>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
206 <!--data format="xlsx" name="output_xlsx" label="crisprFPA - xlsx"/-->
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
207 <data format="txt" name="doseComb" label="doseCombinations - tsv"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
208 <data format="txt" name="dispensingDF" label="dispensingData - tsv"/>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
209 <!--data format="rdata" name="dispensingRDA" label="dispensingData - rda"/-->
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
210
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
211 <!--collection type="list" name="dispensingFiles" label="dispensingFiles">
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
212 <discover_datasets pattern=".csv" format="txt" directory="dispFiles" />
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
213 </collection-->
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
214 </outputs>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
215
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
216
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
217 <help><![CDATA[
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
218 .. class:: infomark
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
219
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
220 Limitations etc:
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
221
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
222 -----
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
223
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
224 **Dataset formats**
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
225
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
226 The input datasets are in text_ (CSV) format and in XML format. The output datasets are also in text_ formats.
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
227
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
228 .. _text: ${static_path}/formatHelp.html#text
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
229
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
230 Specific input file requirements:
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
231
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
232 - **List of drug doses** - `CSV <https://en.wikipedia.org/wiki/Comma-separated_values/>`_ file
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
233
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
234 Provides a list of all the doses for each drug used in
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
235 a drug sensitivity screen. The list needs to include a column with the drug number,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
236 drug name, one or multiple columns for the doses, and a column with the unit.
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
237 ['Number', 'Drug', '6th Dose', ..., '1st Dose', 'Unit'].
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
238 An example is shown with https://raw.githubusercontent.com/Enserink-lab/metascreen/main/inst/extdata/library/listofdoses.csv
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
239
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
240 - **List of drugs.** - `CSV <https://en.wikipedia.org/wiki/Comma-separated_values/>`_ file
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
241
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
242 Provides a list of drugs used in the drug screen. The list
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
243 needs to include a column with a unique drug number / id for each drug, the
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
244 drug name and the CAS number. ['ID', 'NAME', 'CAS_NUMBER']. For custom
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
245 compunds without CAS number, include column, but leave field empty.
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
246 An example is shown with https://raw.githubusercontent.com/Enserink-lab/metascreen/main/inst/extdata/library/listofdrugs.csv
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
247
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
248 - **List of stock concentrations.** - A `CSV <https://en.wikipedia.org/wiki/Comma-separated_values/>`_ file
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
249
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
250 Provides a list of the stock concentrations
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
251 for each drug used in the drug screen. If the stock concentrations are not
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
252 known, use the highest dose. The list needs to include column with the unique
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
253 drug number / id, the drug name, the stock concentration and the concentration unit.
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
254 ['NUMBER', 'NAME', 'CONCENTRATION', 'UNIT'].
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
255 An example is shown with https://raw.githubusercontent.com/Enserink-lab/metascreen/main/inst/extdata/library/listofstockconcentrations.csv
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
256
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
257 - **List of controls.** - A `CSV <https://en.wikipedia.org/wiki/Comma-separated_values/>`_ file
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
258
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
259 Provides the controls to be used in a drug
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
260 screen. The list needs to include a column with the name, CAS number,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
261 dose, unit, the source plate from which the control is dispensed from and the
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
262 volume. ['NAME', 'CAS_NUMBER', 'DOSE', 'UNIT', 'SOURCE_PLATE', 'VOLUME'].
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
263 An example is shown with https://raw.githubusercontent.com/Enserink-lab/metascreen/main/inst/extdata/library/listofctrls.csv
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
264
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
265 - **List of drug volumes.** - A `CSV <https://en.wikipedia.org/wiki/Comma-separated_values/>`_ file
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
266
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
267 Provides the volumes for each drug that
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
268 have been or will be dispensed. The list follows the same format as the
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
269 list of drug doses. The list needs to include a column with the drug number,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
270 drug name, one or multiple columns with doses, and a column with the unit.
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
271 ['Number', 'Drug', 'Vol 6th Dose', ..., 'Vol 1st Dose', 'Unit'].
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
272 An example is shown with https://raw.githubusercontent.com/Enserink-lab/metascreen/main/inst/extdata/library/listofvolumes.csv
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
273
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
274
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
275 - **plateMap** - XML file (s)
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
276
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
277 One or more plate map files with the contents (usually compounds/drugs) of the
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
278 source plate from which drugs are dispensed from. Plate maps can currently be imported
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
279 using .PlateMap (XML files) provided by the IncuCyte® Plate Map Editor. **IMPORTANT: when uploading
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
280 PlateMap files to Galaxy, please make sure you denote file 'Type' as XML.**
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
281
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
282 An example is shown with https://github.com/Enserink-lab/metascreen/blob/main/inst/extdata/library/C008.PlateMap
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
283
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
284 -----
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
285
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
286 **What it does**
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
287
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
288 The *pre-experimental* modules of metascreen is intended to serve the following purposes:
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
289
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
290 set up drug combination screens by (a) generating drug combinations from a list of drugs, and
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
291 (b) distributing those drug combinations across a number of experimental plates,
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
292 (c) generating instructions for dispensing robots for the creation of those
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
293 experimental plates.
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
294
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
295
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
296
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
297
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
298
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
299
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
300 ]]>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
301 </help>
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
302
f6e6b6914b48 Uploaded
sigven
parents:
diff changeset
303 </tool>