annotate README.rst @ 20:f278f8084b2b draft

Deleted selected files
author computationaltranscriptomics
date Thu, 16 Jan 2020 04:44:18 -0500
parents acbcdd5b4c60
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
1 Configuration of Galaxy to run GLASSgo via Docker
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
2 =================================================
13
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
3
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
4 Prerequisites
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
5 -------------
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
6
16
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
7 1) configure Galaxy to run tools in Docker as described at https://galaxyproject.org/admin/tools/docker/.
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
8 In addition, GLASSgo requires the current BLAST nucleotide database. For that, the `tool-data/blastdb.loc`
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
9 has to be configured accordingly as the GLASSgo wrapper reads this information as options when laying out
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
10 the user interface. We use Docker volumes to do so (Docker CLI option -v). For that, we add Docker volumes
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
11 to the (id=`docker_local`) Docker destination
13
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
12
16
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
13 `<param id="docker_volumes">$defaults,/Volumes/TC1/nt:/Volumes/TC1/nt/</param>`
13
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
14
16
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
15 More information can be found in the ./config/job_conf.xml.sample_advanced (https://github.com/galaxyproject/galaxy/blob/release_18.09/config/job_conf.xml.sample_advanced#L378) of any Galaxy instance. Obviously, the exposed folder needs to be identical with the path specified in `tool-data/blastdb.loc`. Here the local folder `Volumes/TC1/nt` contains the BLAST database and is exposed to the Docker container. In this case, the folder is bound to the same location in the container. This allows to execute the GLASSgo call in the tool XML file directly with the selected option.
13
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
16
16
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
17 2) Install GLASSgo from the Galaxy Toolshed (https://toolshed.g2.bx.psu.edu/view/computationaltranscriptomics/glassgo).
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
18 Afterwards, the Galaxy instance needs to be configured such that it is aware of the accession lists. This can be done either
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
19 manually or using a custom script.
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
20
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
21 - manually
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
22 download the accession lists from Zenodo (https://zenodo.org/record/1320180) and add the corresponding paths to the file
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
23 glassgo_accession_list.txt Afterwards, copy the file into the folder tool-data of Galaxy (e.g., /galaxy/tool-data/) or
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
24 - using the script
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
25 use the config_lookup script that downloads the lookup tables and creates glassgo_accession_list.txt in tool-data of the Galaxy instance.
13
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
26
16
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
27 Restart Galaxy.
13
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
28
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
29
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
30 config_lookup
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
31 -------------
16
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
32 We provide the source file config_lookup.py as well as a one-file bundled executable config_lookup
13
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
33 `
16
acbcdd5b4c60 Uploaded
computationaltranscriptomics
parents: 13
diff changeset
34 usage: config_lookup [-h] --galaxy GALAXY [--acclinks ACCLINKS --acclists ACCLISTS]
13
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
35
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
36 incorporate the accession lists in GLASSgo/Galaxy to enable clade-specific searches
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
37
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
38 optional arguments:
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
39 -h, --help show this help message and exit
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
40 --galaxy GALAXY (absolute) path to the root directory of the Galaxy instance
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
41 --acclinks ACCLINKS (absolute) path to file containing URLs to the accession lists
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
42 --acclists ACCLISTS (absolute) path to directory to save the accession lists to
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
43 `
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
44
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
45
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
46