annotate README.txt @ 37:9b64aa8688ad draft

Uploaded
author fubar
date Thu, 28 Aug 2014 02:36:59 -0400
parents
children 8603867451d8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
37
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
1 # WARNING before you start
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
2 # Install this tool on a private Galaxy ONLY
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
3 # Please NEVER on a public or production instance
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
4 # updated august 8 2014 to fix bugs reported by Marius van den Beek
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
5 Please cite:
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
6 http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573?ijkey=lczQh1sWrMwdYWJ&keytype=ref
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
7 if you use this tool in your published work.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
8
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
9 *Short Story*
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
10
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
11 This is an unusual Galaxy tool that exposes unrestricted and therefore extremely dangerous
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
12 scripting to designated administrative users of a Galaxy server, allowing them to run scripts
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
13 in R, python, sh and perl over a single input data set, writing a single new data set as output.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
14
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
15 In addition, this tool optionally generates very simple new Galaxy tools, that effectively
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
16 freeze the supplied script into a new, ordinary Galaxy tool that runs it over a single input file,
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
17 working just like any other Galaxy tool for your users.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
18
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
19 If you use the Html output option, please ensure that sanitize_all_html is set to False and
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
20 uncommented in universe_wsgi.ini - it should show:
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
21
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
22 # By default, all tool output served as 'text/html' will be sanitized
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
23 sanitize_all_html = False
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
24
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
25 *More Detail*
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
26
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
27 To use the ToolFactory, you should have prepared a script to paste into a text box,
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
28 and a small test input example ready to select from your history to test your new script.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
29 There is an example in each scripting language on the Tool Factory form. You can just
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
30 cut and paste these to try it out - remember to select the right interpreter please. You'll
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
31 also need to create a small test data set using the Galaxy history add new data tool.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
32
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
33 If the script fails somehow, use the "redo" button on the tool output in your history to
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
34 recreate the form complete with broken script. Fix the bug and execute again. Rinse, wash, repeat.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
35
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
36 Once the script runs sucessfully, a new Galaxy tool that runs your script can be generated.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
37 Select the "generate" option and supply some help text and names. The new tool will be
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
38 generated in the form of a new Galaxy datatype - toolshed.gz - as the name suggests,
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
39 it's an archive ready to upload to a Galaxy ToolShed as a new tool repository.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
40
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
41 Once it's in a ToolShed, it can be installed into any local Galaxy server from
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
42 the server administrative interface.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
43
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
44 Once the new tool is installed, local users can run it - each time, the script that was supplied
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
45 when it was built will be executed with the input chosen from the user's history. In other words,
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
46 the tools you generate with the ToolFactory run just like any other Galaxy tool,
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
47 but run your script every time.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
48
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
49 Tool factory tools are perfect for workflow components. One input, one output, no variables.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
50
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
51 *To fully and safely exploit the awesome power* of this tool, Galaxy and the ToolShed,
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
52 you should be a developer installing this tool on a private/personal/scratch local instance where you
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
53 are an admin_user. Then, if you break it, you get to keep all the pieces
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
54 see https://bitbucket.org/fubar/galaxytoolfactory/wiki/Home
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
55
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
56 ** Installation **
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
57 This is a Galaxy tool. You can install it most conveniently using the administrative "Search and browse tool sheds" link.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
58 Find the Galaxy Main toolshed at https://toolshed.g2.bx.psu.edu/ and search for the toolfactory repository.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
59 Open it and review the code and select the option to install it.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
60
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
61 (
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
62 If you can't get the tool that way, the xml and py files here need to be copied into a new tools
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
63 subdirectory such as tools/toolfactory Your tool_conf.xml needs a new entry pointing to the xml
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
64 file - something like::
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
65
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
66 <section name="Tool building tools" id="toolbuilders">
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
67 <tool file="toolfactory/rgToolFactory.xml"/>
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
68 </section>
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
69
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
70 If not already there (I just added it to datatypes_conf.xml.sample), please add:
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
71 <datatype extension="toolshed.gz" type="galaxy.datatypes.binary:Binary" mimetype="multipart/x-gzip" subclass="True" />
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
72 to your local data_types_conf.xml.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
73 )
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
74
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
75 Of course, R, python, perl etc are needed on your path if you want to test scripts using those interpreters.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
76 Adding new ones to this tool code should be easy enough. Please make suggestions as bitbucket issues and code.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
77 The HTML file code automatically shrinks R's bloated pdfs, and depends on ghostscript. The thumbnails require imagemagick .
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
78
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
79 * Restricted execution *
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
80 The new tool factory tool will then be usable ONLY by admin users - people with IDs in admin_users in universe_wsgi.ini
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
81 **Yes, that's right. ONLY admin_users can run this tool** Think about it for a moment. If allowed to run any
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
82 arbitrary script on your Galaxy server, the only thing that would impede a miscreant bent on destroying all your
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
83 Galaxy data would probably be lack of appropriate technical skills.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
84
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
85 *What it does* This is a tool factory for simple scripts in python, R and perl currently.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
86 Functional tests are automatically generated. How cool is that.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
87
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
88 LIMITED to simple scripts that read one input from the history.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
89 Optionally can write one new history dataset,
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
90 and optionally collect any number of outputs into links on an autogenerated HTML
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
91 index page for the user to navigate - useful if the script writes images and output files - pdf outputs
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
92 are shown as thumbnails and R's bloated pdf's are shrunk with ghostscript so that and imagemagik need to
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
93 be avaailable.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
94
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
95 Generated tools can be edited and enhanced like any Galaxy tool, so start small and build up since
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
96 a generated script gets you a serious leg up to a more complex one.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
97
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
98 *What you do* You paste and run your script
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
99 you fix the syntax errors and eventually it runs
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
100 You can use the redo button and edit the script before
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
101 trying to rerun it as you debug - it works pretty well.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
102
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
103 Once the script works on some test data, you can
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
104 generate a toolshed compatible gzip file
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
105 containing your script ready to run as an ordinary Galaxy tool in a
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
106 repository on your local toolshed. That means safe and largely automated installation in any
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
107 production Galaxy configured to use your toolshed.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
108
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
109 *Generated tool Security* Once you install a generated tool, it's just
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
110 another tool - assuming the script is safe. They just run normally and their user cannot do anything unusually insecure
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
111 but please, practice safe toolshed.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
112 Read the fucking code before you install any tool.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
113 Especially this one - it is really scary.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
114
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
115 If you opt for an HTML output, you get all the script outputs arranged
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
116 as a single Html history item - all output files are linked, thumbnails for all the pdfs.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
117 Ugly but really inexpensive.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
118
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
119 Patches and suggestions welcome as bitbucket issues please?
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
120
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
121 copyright ross lazarus (ross stop lazarus at gmail stop com) May 2012
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
122
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
123 all rights reserved
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
124 Licensed under the LGPL if you want to improve it, feel free https://bitbucket.org/fubar/galaxytoolfactory/wiki/Home
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
125
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
126 Material for our more enthusiastic and voracious readers continues below - we salute you.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
127
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
128 **Motivation** Simple transformation, filtering or reporting scripts get written, run and lost every day in most busy labs
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
129 - even ours where Galaxy is in use. This 'dark script matter' is pervasive and generally not reproducible.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
130
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
131 **Benefits** For our group, this allows Galaxy to fill that important dark script gap - all those "small" bioinformatics
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
132 tasks. Once a user has a working R (or python or perl) script that does something Galaxy cannot currently do (eg transpose a
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
133 tabular file) and takes parameters the way Galaxy supplies them (see example below), they:
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
134
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
135 1. Install the tool factory on a personal private instance
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
136
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
137 2. Upload a small test data set
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
138
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
139 3. Paste the script into the 'script' text box and iteratively run the insecure tool on test data until it works right -
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
140 there is absolutely no reason to do this anywhere other than on a personal private instance.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
141
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
142 4. Once it works right, set the 'Generate toolshed gzip' option and run it again.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
143
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
144 5. A toolshed style gzip appears ready to upload and install like any other Toolshed entry.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
145
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
146 6. Upload the new tool to the toolshed
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
147
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
148 7. Ask the local admin to check the new tool to confirm it's not evil and install it in the local production galaxy
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
149
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
150 **Simple examples on the tool form**
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
151
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
152 A simple Rscript "filter" showing how the command line parameters can be handled, takes an input file,
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
153 does something (transpose in this case) and writes the results to a new tabular file::
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
154
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
155 # transpose a tabular input file and write as a tabular output file
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
156 ourargs = commandArgs(TRUE)
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
157 inf = ourargs[1]
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
158 outf = ourargs[2]
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
159 inp = read.table(inf,head=F,row.names=NULL,sep='\t')
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
160 outp = t(inp)
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
161 write.table(outp,outf, quote=FALSE, sep="\t",row.names=F,col.names=F)
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
162
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
163 Calculate a multiple test adjusted p value from a column of p values - for this script to be useful,
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
164 it needs the right column for the input to be specified in the code for the
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
165 given input file type(s) specified when the tool is generated ::
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
166
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
167 # use p.adjust - assumes a HEADER row and column 1 - please fix for any real use
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
168 column = 1 # adjust if necessary for some other kind of input
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
169 fdrmeth = 'BH'
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
170 ourargs = commandArgs(TRUE)
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
171 inf = ourargs[1]
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
172 outf = ourargs[2]
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
173 inp = read.table(inf,head=T,row.names=NULL,sep='\t')
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
174 p = inp[,column]
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
175 q = p.adjust(p,method=fdrmeth)
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
176 newval = paste(fdrmeth,'p-value',sep='_')
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
177 q = data.frame(q)
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
178 names(q) = newval
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
179 outp = cbind(inp,newval=q)
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
180 write.table(outp,outf, quote=FALSE, sep="\t",row.names=F,col.names=T)
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
181
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
182
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
183
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
184 Another Rscript example without any input file - generates a random heatmap pdf - you must make sure the option to create an HTML output file is
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
185 turned on for this to work. The heatmap will be presented as a thumbnail linked to the pdf in the resulting HTML page::
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
186
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
187 # note this script takes NO input or output because it generates random data
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
188 foo = data.frame(a=runif(100),b=runif(100),c=runif(100),d=runif(100),e=runif(100),f=runif(100))
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
189 bar = as.matrix(foo)
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
190 pdf( "heattest.pdf" )
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
191 heatmap(bar,main='Random Heatmap')
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
192 dev.off()
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
193
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
194 A Python example that reverses each row of a tabular file. You'll need to remove the leading spaces for this to work if cut
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
195 and pasted into the script box. Note that you can already do this in Galaxy by setting up the cut columns tool with the
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
196 correct number of columns in reverse order,but this script will work for any number of columns so is completely generic::
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
197
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
198 # reverse order of columns in a tabular file
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
199 import sys
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
200 inp = sys.argv[1]
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
201 outp = sys.argv[2]
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
202 i = open(inp,'r')
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
203 o = open(outp,'w')
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
204 for row in i:
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
205 rs = row.rstrip().split('\t')
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
206 rs.reverse()
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
207 o.write('\t'.join(rs))
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
208 o.write('\n')
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
209 i.close()
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
210 o.close()
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
211
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
212
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
213 Galaxy as an IDE for developing API scripts
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
214 If you need to develop Galaxy API scripts and you like to live dangerously, please read on.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
215
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
216 Galaxy as an IDE?
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
217 Amazingly enough, blend-lib API scripts run perfectly well *inside* Galaxy when pasted into a Tool Factory form. No need to generate a new tool. Galaxy+Tool_Factory = IDE I think we need a new t-shirt. Seriously, it is actually quite useable.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
218
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
219 Why bother - what's wrong with Eclipse
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
220 Nothing. But, compared with developing API scripts in the usual way outside Galaxy, you get persistence and other framework benefits plus at absolutely no extra charge, a ginormous security problem if you share the history or any outputs because they contain the api script with key so development servers only please!
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
221
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
222 Workflow
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
223 Fire up the Tool Factory in Galaxy.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
224
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
225 Leave the input box empty, set the interpreter to python, paste and run an api script - eg working example (substitute the url and key) below.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
226
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
227 It took me a few iterations to develop the example below because I know almost nothing about the API. I started with very simple code from one of the samples and after each run, the (edited..) api script is conveniently recreated using the redo button on the history output item. So each successive version of the developing api script you run is persisted - ready to be edited and rerun easily. It is ''very'' handy to be able to add a line of code to the script and run it, then view the output to (eg) inspect dicts returned by API calls to help move progressively deeper iteratively.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
228
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
229 Give the below a whirl on a private clone (install the tool factory from the main toolshed) and try adding complexity with few rerun/edit/rerun cycles.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
230
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
231 Eg tool factory api script
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
232 import sys
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
233 from blend.galaxy import GalaxyInstance
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
234 ourGal = 'http://x.x.x.x:xxxx'
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
235 ourKey = 'xxx'
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
236 gi = GalaxyInstance(ourGal, key=ourKey)
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
237 libs = gi.libraries.get_libraries()
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
238 res = []
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
239 # libs looks like
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
240 # u'url': u'/galaxy/api/libraries/441d8112651dc2f3', u'id': u'441d8112651dc2f3', u'name':.... u'Demonstration sample RNA data',
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
241 for lib in libs:
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
242 res.append('%s:\n' % lib['name'])
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
243 res.append(str(gi.libraries.show_library(lib['id'],contents=True)))
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
244 outf=open(sys.argv[2],'w')
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
245 outf.write('\n'.join(res))
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
246 outf.close()
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
247
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
248 **Attribution**
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
249 Creating re-usable tools from scripts: The Galaxy Tool Factory
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
250 Ross Lazarus; Antony Kaspi; Mark Ziemann; The Galaxy Team
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
251 Bioinformatics 2012; doi: 10.1093/bioinformatics/bts573
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
252
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
253 http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573?ijkey=lczQh1sWrMwdYWJ&keytype=ref
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
254
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
255 **Licensing**
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
256 Copyright Ross Lazarus 2010
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
257 ross lazarus at g mail period com
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
258
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
259 All rights reserved.
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
260
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
261 Licensed under the LGPL
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
262
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
263 **Obligatory screenshot**
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
264
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
265 http://bitbucket.org/fubar/galaxytoolmaker/src/fda8032fe989/images/dynamicScriptTool.png
9b64aa8688ad Uploaded
fubar
parents:
diff changeset
266