annotate README.rst @ 3:5ce172ccbe9b draft

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