annotate README.rst @ 4:3284a0c7570e draft

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