annotate galaxy-tools/biobank/tools/query.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_tools_query" name="VLT.query">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
2 <description>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
3 Provides a simplified environment to perform complex queries to
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
4 BIOBANK.
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
5 </description>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
6 <command interpreter="bash">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
7 launcher.sh
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
8 --interpreter=python
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
9 --runner=kb_query.py
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
10 --host=$__user_omero_host__
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
11 --user=$__user_omero_user__
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
12 --passwd=$__user_omero_password__
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
13 --operator=$__user_email__
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
14 --ofile=${output1}
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
15 --logfile=${logfile}
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
16 query
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
17 --group=$study
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
18 --code-file=$code_file
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
19 </command>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
20 <inputs>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
21 <param name="study" type="select" label="study label"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
22 help="Choose one of the available groups/studies.
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
23 See below.">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
24 <options from_parameter="tool.app.known_studies"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
25 transform_lines="[ &quot;%s%s%s:%s&quot;
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
26 % ( l[0], self.separator, l[0], l[1][:40] )
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
27 for l in obj ]">
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
28 <column name="value" index="0"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
29 <column name="name" index="1"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
30 <filter type="sort_by" column="0"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
31 </options>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
32 </param>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
33 <param name="query_code" type="text" area="True" size="10x60"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
34 optional="False"
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
35 value=""
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
36 />
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
37 <!-- ************************************************** -->
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
38
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
39 </inputs>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
40
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
41 <configfiles>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
42 <configfile name="code_file">${str($query_code).replace('__sq__', "'").replace('__cr____cn__', '\n')}</configfile>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
43 </configfiles>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
44
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
45 <outputs>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
46 <data format="tabular" name="output1" label="${tool.name}.mapped"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
47 <data format="txt" name="logfile" label="${tool.name}.logfile"/>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
48 </outputs>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
49
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
50 <help>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
51 The following is an example of a query that will dump family relations
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
52 within the group::
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
53
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
54 writeheader('study', 'id', 'gender', 'father', 'mother')
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
55 for i in Individuals(group):
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
56 writerow(group.id, enum_label(i.gender),
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
57 i.father.id if i.father else 'None',
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
58 i.mother.id if i.mother else 'None')
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
59
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
60
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
61 The next example will prepare a file that could be used to define a
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
62 data collection and then as the input for a genotyping run::
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
63
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
64 writeheader('dc_id', 'gender', 'data_sample',
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
65 'path', 'mimetype', 'size', 'sha1')
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
66 for i in Individuals(group):
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
67 for d in DataSamples(i, 'AffymetrixCel'):
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
68 for o in DataObjects(d):
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
69 writerow(group.id, enum_label(i.gender), d.id,
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
70 o.path, o.mimetype, o.size, o.sha1)
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
71
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
72 In the examples above, '''group''' (actually a study) corresponds to
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
73 the group whose label is assigned by the '''--group''' flag.
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
74
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
75 **Note** This is clearly an extremely dangerous tool.
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
76
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
77 </help>
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
78
ba6cf6ede027 Uploaded
ric
parents:
diff changeset
79 </tool>