annotate galaxy-tools/biobank/importer/data_sample.xml @ 0:ba6cf6ede027 draft default tip

Uploaded
author ric
date Wed, 28 Sep 2016 06:03:30 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
1 <tool id="vl_import_data_sample" name="VLI.data_sample">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
2 <description>import DataSample definitions within OMERO.biobank</description>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
3 <command interpreter="bash">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
4 launcher.sh
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
5 --interpreter=python
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
6 --runner=importer.py
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
7 #if $omero_configuration.level == 'advanced'
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
8 --host=$omero_configuration.vl_host
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
9 --user=$omero_configuration.vl_user
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
10 --passwd=$omero_configuration.vl_passwd
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
11 #else
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
12 --host=$__user_omero_host__
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
13 --user=$__user_omero_user__
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
14 --passwd=$__user_omero_password__
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
15 #end if
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
16 --operator=$__user_email__
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
17 --ifile=${input}
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
18 --ofile=${output}
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
19 --report_file=${report}
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
20 --logfile=${logfile}
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
21 #if $blocking_validation
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
22 --blocking-validator
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
23 #end if
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
24 data_sample
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
25 #if str($study) != 'use_provided'
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
26 --study ${study}
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
27 #end if
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
28 #if str($source_type) != 'use_provided'
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
29 --source-type=${source_type}
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
30 #end if
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
31 #if str($device_type) != 'use_provided'
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
32 --device-type=${device_type}
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
33 #end if
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
34 #if str($scanner) != 'use_provided'
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
35 --scanner=${scanner}
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
36 #end if
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
37 #if str($data_sample_type) != 'use_provided'
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
38 --data-sample-type=${data_sample_type}
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
39 #end if
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
40 </command>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
41
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
42 <inputs>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
43 <param format="tabular" name="input" type="data"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
44 label="A tabular dataset with the following columns ..."/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
45
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
46 <param name="study" type="select" label="Context study" ajax = "True" ajax-source = "galaxy/get/studies" sort="True"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
47 help="Choose from the already defined studies. See below.">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
48 <option value="use_provided" selected="true">Records provide study labels</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
49 </param>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
50
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
51 <param name="source_type" type="select"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
52 label="Type of the source"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
53 help="Choose from the following. See below.">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
54 <option value="use_provided" selected="true">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
55 Use record provided
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
56 </option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
57 <option value="Individual">Individual</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
58 <option value="Tube">Tube</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
59 <option value="PlateWell">PlateWell</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
60 <option value="DataSample">DataSample</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
61 <option value="DataCollectionItem">DataCollectionItem</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
62 <option value="IlluminaBeadChipArray">IlluminaBeadChipArray</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
63 <option value="IlluminaBeadChipMeasures">IlluminaBeadChipMeasures</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
64 </param>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
65
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
66 <param name="device_type" type="select"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
67 label="Type of the device"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
68 help="Choose from the following. See below.">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
69 <option value="use_provided" selected="true">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
70 Use record provided</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
71 <option value="Device">Device</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
72 <option value="Chip">Chip</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
73 <option value="SoftwareProgram">SoftwareProgram</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
74 </param>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
75
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
76
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
77 <param name="data_sample_type" type="select"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
78 label="Type of the data sample"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
79 help="Choose from the following. See below.">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
80 <option value="use_provided" selected="true">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
81 Use record provided</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
82 <option value="GenotypeDataSample">GenotypeDataSample</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
83 <option value="IlluminaBeadChipMeasure">IlluminaBeadChipMeasure</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
84 <option value="GenomeVariationsDataSample">GenomeVariationsDataSample</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
85 </param>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
86
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
87 <param name="scanner" type="select" label="Scanner used" ajax = "True" ajax-source = "galaxy/get/scanners" sort="True"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
88 help="Choose from the possible scanners. See below.">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
89 <option value="use_provided" selected="true">Records provide scanner ids</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
90 </param>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
91
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
92 <!-- ************************************************** -->
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
93 <param name="blocking_validation" type="boolean" checked="false"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
94 label="Blocking validation"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
95 help="When this check is enabled, if at least one record doesn't pass importer's validation, the entire import procedure will be blocked"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
96
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
97 <conditional name="wait_for_trigger">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
98 <param name="enable_trigger" type="boolean" checked="false"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
99 label="Wait for another tool to end before running this tool"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
100 <when value="true">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
101 <param format="txt" name="trigger_file" type="data"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
102 label="Select the LOG file that will be used as trigger"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
103 </when>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
104 </conditional>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
105
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
106 <conditional name="omero_configuration">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
107 <param name="level" type="select" label="Configuration level">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
108 <option value="default" selected="true">Default: use Galaxy's preferences</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
109 <option value="advanced">Advanced: specify different host, user
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
110 and password</option>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
111 </param>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
112 <when value="default"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
113 <when value="advanced">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
114 <param name="vl_host" size="40" type="text" value="hostname"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
115 label="OMERO.biobank host"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
116 <param name="vl_user" size="40" type="text" value="user"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
117 label="OMERO.biobank user"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
118 <param name="vl_passwd" size="40" type="text" value="password"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
119 label="OMERO.biobank passwd"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
120 </when>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
121 </conditional>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
122
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
123 </inputs>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
124
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
125 <outputs>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
126 <data format="tabular" name="output" label="${tool.name}.mapping"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
127 <data format="tabular" name="report" label="${tool.name}.report"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
128 <data format="txt" name="logfile" label="${tool.name}.logfile"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
129 </outputs>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
130
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
131 <stdio>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
132 <exit_code range="1:" level="fatal" />
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
133 </stdio>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
134
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
135 <help>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
136 Will read in a tsv file with the following columns::
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
137
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
138 study label source device device_type scanner options
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
139 ASTUDY foo01 v03909 v9309 Chip v99020 celID=0009099090
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
140 ASTUDY foo02 v03909 v99022 Scanner v99022 conf1=...,conf2=...
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
141 ....
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
142
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
143 In this example, the first line corresponds to a dataset obtained by
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
144 using chip v9309 on scanner v99020, while the second datasample has
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
145 been obtained using a technology directly using a scanner, e.g., an
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
146 Illumina HiSeq 2000. The '''scanner''' column is there as a
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
147 convenience to support a more detailed description of a chip-based
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
148 acquisition.
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
149
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
150 The general strategy is to decide what data objects should be
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
151 instantiated by looking at the chip column and at its corresponding
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
152 maker,model,release.
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
153
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
154 The optional column '''scanner''', the vid of the scanner device, is
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
155 used in cases, such as Affymetrix genotyping, where it is relevant.
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
156
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
157 It is also possible to import DataSample(s) that are the results of
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
158 processing other DataSample(s). Here is an example::
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
159
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
160 study label source device device_type options
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
161 ASTUDY foo01 v03909 v99021 SoftwareProgram conf1=...,conf2=...
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
162 ASTUDY foo02 v03909 v99021 SoftwareProgram conf1=...,conf2=...
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
163 ....
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
164 </help>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
165 </tool>