Mercurial > repos > mvdbeek > docker_toolfactory

annotate README.txt @ 0:0fa46413d0d9 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
author mvdbeek
date Sat, 03 Oct 2015 08:34:39 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
1 # WARNING before you start
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
2 # Carefully inspect tool usage. If bugs are found within the tool, users may be able to break
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
3 # out of the container and mount files on the host system.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
4
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
5 This is a fork of toolfactory that makes use of Docker to sandbox the generated script.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
6 As such you need to have the system user under which galaxy tools are executed be able to run Docker.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
7 On Ubuntu you can do this by adding your galaxy user to the docker group (http://askubuntu.com/questions/477551/how-can-i-use-docker-without-sudo).
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
8 Assuming galaxy runs as the user galaxy, this is the short form for installing Docker from the official docker Ubuntu Trusty repository:
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
9
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
10 sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
11 sudo sh -c "echo deb https://get.docker.io/ubuntu docker main > /etc/apt/sources.list.d/docker.list"
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
12 sudo apt-get update
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
13 sudo apt-get install lxc-docker
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
14 sudo gpasswd -a galaxy docker
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
15 sudo service docker restart
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
16
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
17 Eventually the galaxy process might need to be restarted.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
18
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
19 On OSX, you need to boot2docker installed and available to the galaxy user.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
20
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
21 Note that this could bring severe security problems in case untrusted users can become this user.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
22 If you want to use this tool, read and understand the following article:
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
23 https://docs.docker.com/articles/security/#docker-daemon-attack-surface
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
24
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
25 Work is ongoing, some important features are missing, like being able to manage containers.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
26 Currently, only a single container with pre-installed tools is available.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
27
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
28 This is an beta-stage, potentially dangerous tool.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
29
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
30 Please cite:
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
31 - http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573?ijkey=lczQh1sWrMwdYWJ&keytype=ref
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
32 - van den Beek M., Antoniewski C., in preparation
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
33 if you use this tool in your published work.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
34
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
35 *Short Story*
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
36
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
37 This is an unusual Galaxy tool that exposes unrestricted scripting to users of a Galaxy server,
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
38 allowing them to run scripts in R, python, sh and perl over input datasets,
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
39 writing a single new data set as output.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
40
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
41 In addition, this tool optionally generates very simple new Galaxy tools, that effectively
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
42 freeze the supplied script into a new, ordinary Galaxy tool that runs it over one or more input files,
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
43 working just like any other Galaxy tool for your users.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
44
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
45 To use the ToolFactory, you should have prepared a script to paste into a text box,
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
46 and a small test input example ready to select from your history to test your new script.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
47 There is an example in each scripting language on the Tool Factory form. You can just
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
48 cut and paste these to try it out - remember to select the right interpreter please. You'll
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
49 also need to create a small test data set using the Galaxy history add new data tool.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
50
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
51 If the script fails somehow, use the "redo" button on the tool output in your history to
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
52 recreate the form complete with broken script. Fix the bug and execute again. Rinse, wash, repeat.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
53
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
54 Once the script runs sucessfully, a new Galaxy tool that runs your script can be generated.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
55 Select the "generate" option and supply some help text and names. The new tool will be
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
56 generated in the form of a new Galaxy datatype - toolshed.gz - as the name suggests,
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
57 it's an archive ready to upload to a Galaxy ToolShed as a new tool repository.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
58
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
59 Once it's in a ToolShed, it can be installed into any local Galaxy server from
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
60 the Galaxy administrative interface.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
61
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
62 Once the new tool is installed, local users can run it - each time, the script that was supplied
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
63 when it was built will be executed with the input chosen from the user's history. In other words,
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
64 the tools you generate with the ToolFactory run just like any other Galaxy tool,
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
65 but run your script every time.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
66
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
67 Tool factory tools are perfect for workflow components. One input, one output, no variables.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
68
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
69 *Reasons to read further*
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
70
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
71 If you use Galaxy to support your research;
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
72
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
73 You and fellow users are sometimes forced to take data out of Galaxy, process it with ugly
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
74 little perl/awk/sed/R... scripts and put it back;
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
75
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
76 You do this when you can't do some transformation in Galaxy (the 90/10 rule);
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
77
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
78 You don't have enough developer resources for wrapping dozens of even relatively simple tools;
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
79
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
80 Your research and your institution would be far better off if those feral scripts were all tucked
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
81 safely in your local toolshed and Galaxy histories.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
82
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
83 *The good news* If it can be trivially scripted, it can be running safely in your
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
84 local Galaxy via your own local toolshed in a few minutes - with functional tests.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
85
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
86
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
87 *Value proposition* The ToolFactory allows Galaxy to efficiently take over most of your lab's
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
88 dark script matter, making it reproducible in Galaxy and shareable through the ToolShed.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
89
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
90 That's what this tool does. You paste a simple script and the tool returns
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
91 a new, real Galaxy tool, ready to be installed from the local toolshed to local servers.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
92 Scripts can be wrapped and online literally within minutes.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
93
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
94 *To fully and safely exploit the awesome power* of this tool, Galaxy and the ToolShed,
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
95 you should be a developer installing this tool on a private/personal/scratch local instance where you
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
96 are an admin_user. Then, if you break it, you get to keep all the pieces
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
97 see https://bitbucket.org/fubar/galaxytoolfactory/wiki/Home
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
98
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
99 ** Installation **
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
100 This is a Galaxy tool. You can install it most conveniently using the administrative "Search and browse tool sheds" link.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
101 Find the Galaxy Test toolshed (not main) and search for the toolfactory repository.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
102 Open it and review the code and select the option to install it.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
103
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
104 If you can't get the tool that way, the xml and py files here need to be copied into a new tools
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
105 subdirectory such as tools/toolfactory Your tool_conf.xml needs a new entry pointing to the xml
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
106 file - something like::
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
107
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
108 <section name="Tool building tools" id="toolbuilders">
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
109 <tool file="DockerToolFactory.xml"/>
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
110 </section>
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
111
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
112 If not already there (I just added it to datatypes_conf.xml.sample), please add:
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
113 <datatype extension="toolshed.gz" type="galaxy.datatypes.binary:Binary" mimetype="multipart/x-gzip" subclass="True" />
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
114 to your local data_types_conf.xml.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
115
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
116 Ensure that html sanitization is set to False and uncommented in universe_wsgi.ini
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
117
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
118 You'll have to restart the server for the new tool to be available.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
119
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
120 R, python, perl are preloaded in the supplied Dockerfile.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
121 Upon first execution the Dockerfile will be used to build an image
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
122 with varius pre-installed tools.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
123 Adding new ones should be easy enough, and follows standard conventions
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
124 for Docker tools.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
125 Please make suggestions as bitbucket issues and code.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
126 The HTML file code automatically shrinks R's bloated pdfs, and depends on ghostscript. The thumbnails require imagemagick .
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
127
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
128 *What it does* This is a tool factory for simple scripts in python, R and perl currently.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
129 Functional tests are automatically generated.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
130 On a technical level, a Docker container is started, and input and output files
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
131 are made available to the container.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
132 After running, the docker container will be terminated.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
133
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
134 LIMITED to simple scripts that read inputs from the history.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
135 Optionally can write one new history dataset, and optionally collect any number of outputs into links on an autogenerated HTML
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
136 index page for the user to navigate - useful if the script writes images and output files - pdf outputs
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
137 are shown as thumbnails and R's bloated pdf's are shrunk with ghostscript so that and imagemagik need to
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
138 be avaailable.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
139
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
140 Generated tools can be edited and enhanced like any Galaxy tool, so start small and build up since
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
141 a generated script gets you a serious leg up to a more complex one.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
142
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
143 *What you do* You paste and run your script
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
144 you fix the syntax errors and eventually it runs
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
145 You can use the redo button and edit the script before
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
146 trying to rerun it as you debug - it works pretty well.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
147
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
148 Once the script works on some test data, you can
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
149 generate a toolshed compatible gzip file
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
150 containing your script ready to run as an ordinary Galaxy tool in a
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
151 repository on your local toolshed. That means safe and largely automated installation in any
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
152 production Galaxy configured to use your toolshed.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
153
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
154 *Generated tool Security* Once you install a generated tool, it's just
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
155 another tool - assuming the script is safe. They just run normally and their user cannot do anything unusually insecure
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
156 but please, practice safe toolshed.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
157 Read the fucking code before you install any tool.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
158 Especially this one - it is really scary.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
159
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
160 If you opt for an HTML output, you get all the script outputs arranged
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
161 as a single Html history item - all output files are linked, thumbnails for all the pdfs.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
162 Ugly but really inexpensive.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
163
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
164 Patches and suggestions welcome as bitbucket issues please?
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
165
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
166
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
167 copyright ross lazarus (ross stop lazarus at gmail stop com) May 2012
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
168
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
169 all rights reserved
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
170 Licensed under the LGPL if you want to improve it, feel free https://bitbucket.org/fubar/galaxytoolfactory/wiki/Home
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
171
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
172 Material for our more enthusiastic and voracious readers continues below - we salute you.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
173
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
174 **Motivation** Simple transformation, filtering or reporting scripts get written, run and lost every day in most busy labs
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
175 - even ours where Galaxy is in use. This 'dark script matter' is pervasive and generally not reproducible.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
176
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
177 **Benefits** For our group, this allows Galaxy to fill that important dark script gap - all those "small" bioinformatics
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
178 tasks. Once a user has a working R (or python or perl) script that does something Galaxy cannot currently do (eg transpose a
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
179 tabular file) and takes parameters the way Galaxy supplies them (see example below), they:
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
180
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
181 1. Install the tool factory on a personal private instance
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
182
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
183 2. Upload a small test data set
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
184
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
185 3. Paste the script into the 'script' text box and iteratively run the insecure tool on test data until it works right -
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
186 there is absolutely no reason to do this anywhere other than on a personal private instance.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
187
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
188 4. Once it works right, set the 'Generate toolshed gzip' option and run it again.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
189
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
190 5. A toolshed style gzip appears ready to upload and install like any other Toolshed entry.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
191
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
192 6. Upload the new tool to the toolshed
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
193
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
194 7. Ask the local admin to check the new tool to confirm it's not evil and install it in the local production galaxy
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
195
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
196 **Simple examples on the tool form**
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
197
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
198 A simple Rscript "filter" showing how the command line parameters can be handled, takes an input file,
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
199 does something (transpose in this case) and writes the results to a new tabular file::
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
200
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
201 # transpose a tabular input file and write as a tabular output file
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
202 ourargs = commandArgs(TRUE)
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
203 inf = ourargs[1]
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
204 outf = ourargs[2]
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
205 inp = read.table(inf,head=F,row.names=NULL,sep='\t')
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
206 outp = t(inp)
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
207 write.table(outp,outf, quote=FALSE, sep="\t",row.names=F,col.names=F)
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
208
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
209 Calculate a multiple test adjusted p value from a column of p values - for this script to be useful,
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
210 it needs the right column for the input to be specified in the code for the
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
211 given input file type(s) specified when the tool is generated ::
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
212
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
213 # use p.adjust - assumes a HEADER row and column 1 - please fix for any real use
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
214 column = 1 # adjust if necessary for some other kind of input
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
215 fdrmeth = 'BH'
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
216 ourargs = commandArgs(TRUE)
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
217 inf = ourargs[1]
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
218 outf = ourargs[2]
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
219 inp = read.table(inf,head=T,row.names=NULL,sep='\t')
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
220 p = inp[,column]
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
221 q = p.adjust(p,method=fdrmeth)
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
222 newval = paste(fdrmeth,'p-value',sep='_')
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
223 q = data.frame(q)
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
224 names(q) = newval
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
225 outp = cbind(inp,newval=q)
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
226 write.table(outp,outf, quote=FALSE, sep="\t",row.names=F,col.names=T)
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
227
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
228
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
229
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
230 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
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
231 turned on for this to work. The heatmap will be presented as a thumbnail linked to the pdf in the resulting HTML page::
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
232
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
233 # note this script takes NO input or output because it generates random data
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
234 foo = data.frame(a=runif(100),b=runif(100),c=runif(100),d=runif(100),e=runif(100),f=runif(100))
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
235 bar = as.matrix(foo)
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
236 pdf( "heattest.pdf" )
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
237 heatmap(bar,main='Random Heatmap')
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
238 dev.off()
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
239
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
240 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
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
241 and pasted into the script box. Note that you can already do this in Galaxy by setting up the cut columns tool with the
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
242 correct number of columns in reverse order,but this script will work for any number of columns so is completely generic::
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
243
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
244 # reverse order of columns in a tabular file
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
245 import sys
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
246 inp = sys.argv[1]
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
247 outp = sys.argv[2]
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
248 i = open(inp,'r')
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
249 o = open(outp,'w')
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
250 for row in i:
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
251 rs = row.rstrip().split('\t')
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
252 rs.reverse()
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
253 o.write('\t'.join(rs))
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
254 o.write('\n')
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
255 i.close()
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
256 o.close()
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
257
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
258
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
259 Galaxy as an IDE for developing API scripts
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
260 If you need to develop Galaxy API scripts and you like to live dangerously, please read on.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
261
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
262 Galaxy as an IDE?
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
263 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.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
264
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
265 Why bother - what's wrong with Eclipse
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
266 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!
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
267
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
268 Workflow
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
269 Fire up the Tool Factory in Galaxy.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
270
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
271 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.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
272
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
273 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.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
274
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
275 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.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
276
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
277 Eg tool factory api script
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
278 import sys
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
279 from blend.galaxy import GalaxyInstance
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
280 ourGal = 'http://x.x.x.x:xxxx'
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
281 ourKey = 'xxx'
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
282 gi = GalaxyInstance(ourGal, key=ourKey)
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
283 libs = gi.libraries.get_libraries()
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
284 res = []
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
285 # libs looks like
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
286 # u'url': u'/galaxy/api/libraries/441d8112651dc2f3', u'id': u'441d8112651dc2f3', u'name':.... u'Demonstration sample RNA data',
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
287 for lib in libs:
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
288 res.append('%s:\n' % lib['name'])
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
289 res.append(str(gi.libraries.show_library(lib['id'],contents=True)))
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
290 outf=open(sys.argv[2],'w')
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
291 outf.write('\n'.join(res))
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
292 outf.close()
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
293
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
294 **Attribution**
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
295 Creating re-usable tools from scripts: The Galaxy Tool Factory
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
296 Ross Lazarus; Antony Kaspi; Mark Ziemann; The Galaxy Team
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
297 Bioinformatics 2012; doi: 10.1093/bioinformatics/bts573
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
298
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
299 http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573?ijkey=lczQh1sWrMwdYWJ&keytype=ref
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
300
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
301 **Licensing**
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
302 Copyright Ross Lazarus 2010
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
303 ross lazarus at g mail period com
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
304
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
305 All rights reserved.
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
306
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
307 Licensed under the LGPL
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
308
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
309 **Obligatory screenshot**
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
310
0fa46413d0d9 planemo upload for repository https://bitbucket.org/mvdbeek/dockertoolfactory/ commit 2f33eb59c06ac3d6ba6e22622fd4ae729eb5e4da-dirty
mvdbeek
parents:
diff changeset
311 http://bitbucket.org/fubar/galaxytoolmaker/src/fda8032fe989/images/dynamicScriptTool.png