annotate README.rst @ 13:76b7a84ba942 draft

Uploaded
author computationaltranscriptomics
date Tue, 14 Jan 2020 06:03:45 -0500
parents
children acbcdd5b4c60
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
1 Configuration of Galaxy to run GLASSgo in Docker
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
2 ================================================
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
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
7 1) configure Galaxy to run tools in Docker as described at \
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
8 https://galaxyproject.org/admin/tools/docker/. In addition, GLASSgo requires the current BLAST nucleotide database. For that, the `tool-data/blastdb.loc` has to be configured accordingly as the GLASSgo wrapper reads this information as options when laying out the user interface. We use Docker volumes to do so (Docker CLI option -v).
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
9 For that, we add Docker volumes to the (id=`docker_local`) Docker destination
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
10
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
11 `<param id="docker_volumes">$defaults,/Volumes/TC1/nt:/Volumes/TC1/nt/</param>`
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
12
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
13 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.
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
14
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
15 2) Install GLASSgo from the Galaxy Toolshed
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
16 (https://toolshed.g2.bx.psu.edu/view/computationaltranscriptomics/glassgo).
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
17 Afterwards, the Galaxy instance needs to be configured such that it is aware of the accession lists. This can be done either manually or using a custom script.
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
18
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
19 - download the accession lists from Zenodo (https://zenodo.org/record/1320180) and copy the file `glassgo_accession_list.txt` (./tool-data/glassgo_accession_list.txt) into the folder `tool-data` of Galaxy (e.g., `/galaxy/tool-data/`) or
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
20
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
21 - use `config_lookup` (./config_lookup/dist/) to download the look tables using `accession_lists_links.txt`(./accession_lists_links.txt)
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
22 (option --acclinks) and creates `glassgo_accession_list.txt` in `tool-data` of Galaxy.
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
23
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
24 Note: Any changes of files within `tool-data` requires a (re)start of Galaxy.
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
25
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
26
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
27 config_lookup
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
28 -------------
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
29 `
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
30 usage: config_lookup [-h] --galaxy GALAXY --acclinks ACCLINKS [--acclists ACCLISTS]
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
31
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
32 incorporate the accession lists in GLASSgo/Galaxy to enable clade-specific searches
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
33
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
34 optional arguments:
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
35 -h, --help show this help message and exit
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
36 --galaxy GALAXY (absolute) path to the root directory of the Galaxy instance
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
37 --acclinks ACCLINKS (absolute) path to file containing URLs to the accession lists
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
38 --acclists ACCLISTS (absolute) path to directory to save the accession lists to
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
39 `
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
40
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
41
76b7a84ba942 Uploaded
computationaltranscriptomics
parents:
diff changeset
42