annotate README.rst @ 9:e02e50e67ca7 draft

"planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit dc7fe1feecc587f7bc5d09108fbf016b0fd317bc"
author gga
date Mon, 18 Nov 2019 09:58:49 -0500
parents cdf222d77b32
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
1 Galaxy-chado
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
2 =============
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
3
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
4 Galaxy tools to interface with Tripal using python-chado
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
5
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
6 Dependencies
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
7 ------------
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
8
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
9 You will need to install some python modules in the Galaxy virtualenv for these
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
10 tools to be fully functional:
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
11
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
12 .. code:: bash
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
13
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
14 . /path/to/galaxy/.venv/bin/activate
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
15 pip install future chado
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
16 deactivate
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
17
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
18 Environment
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
19 -----------
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
20
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
21 The following environment variables must be set:
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
22
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
23 +--------------------------------+-----------------------------------------------------------+
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
24 | ENV | Use |
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
25 +================================+===========================================================+
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
26 | ``$GALAXY_CHADO_DBHOST`` | Host of the Chado database |
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
27 +--------------------------------+-----------------------------------------------------------+
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
28 | ``$GALAXY_CHADO_DBNAME`` | Name of the Chado database |
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
29 +--------------------------------+-----------------------------------------------------------+
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
30 | ``$GALAXY_CHADO_DBUSER`` | Username to connect to the database |
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
31 +--------------------------------+-----------------------------------------------------------+
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
32 | ``$GALAXY_CHADO_DBPASS`` | Password to connect to the database |
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
33 +--------------------------------+-----------------------------------------------------------+
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
34 | ``$GALAXY_CHADO_DBSCHEMA`` | Database schema. |
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
35 +--------------------------------+-----------------------------------------------------------+
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
36 | ``$GALAXY_CHADO_DBPORT`` | Port of the Chado database |
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
37 +--------------------------------+-----------------------------------------------------------+
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
38
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
39
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
40 License
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
41 -------
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
42
cdf222d77b32 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/chado commit 3c4fb887c809face4fbe4602617d6dc094b15864
gga
parents:
diff changeset
43 All python scripts and wrappers are licensed under MIT license.