Skip to content

Commit e2b2c4e

Browse files
committed
update README with ephemeris yaml file
1 parent 0e048f8 commit e2b2c4e

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,8 @@ FROGS-wrappers allow to add FROGS on a Galaxy instance.
2121
# Table of content
2222

2323
* [Installing FROGS\-wrappers](#installing-frogs-wrappers)
24-
* [Use PEAR as reads merge software in preprocess](#use-pear-as-reads-merge-software-in-preprocess)
2524
* [Upload and configure the databanks](#upload-and-configure-the-databanks)
2625
* [Galaxy configuration](#galaxy-configuration)
27-
* [Setup Galaxy environment variables](#setup-galaxy-environment-variables)
28-
* [Install python packages inside virtual env](#install-python-packages-inside-virtual-env)
2926
* [Avoid FROGS HTML report sanitization](#avoid-FROGS-HTML-report-sanitization)
3027
* [Set memory and parallelisation settings](#set-memory-and-parallelisation-settings)
3128
* [License](#license)
@@ -37,13 +34,37 @@ FROGS-wrappers allow to add FROGS on a Galaxy instance.
3734

3835
FROGS and is data manager are available on the Toolshed (owner : frogs).
3936

40-
It will install FROGS thanks to [conda](https://anaconda.org/bioconda/frogs), download all these XML tools and well configure them in your Galaxy.
37+
It will install FROGS thanks to [conda](https://anaconda.org/bioconda/frogs), download XML tools and well configure them in your Galaxy.
4138

4239
The 28 FROGS tools are wrapped in 4 Galaxy tools:
4340
* FROGS_Core tools is composed of a Main tools wrapper and a Companion tools wrapper, each including 8 FROGS tools : https://toolshed.g2.bx.psu.edu/view/frogs/frogs_core
4441
* FROGS_Stat tool including 9 FROGS tools : https://toolshed.g2.bx.psu.edu/view/frogs/frogs_stat
4542
* FROGS_Func tool including 3 FROGS tools: https://toolshed.g2.bx.psu.edu/view/frogs/frogs_func
4643

44+
To install FROGS-wrappers, you can follow the official Galaxy documentation : https://galaxyproject.org/admin/tools/add-tool-from-toolshed-tutorial/. You may install tools via Galaxy admin interface or in commande line using Ephemeris.
45+
46+
For ephemeris, you can adapt the yaml file :
47+
```
48+
install_tool_dependencies: True
49+
install_repository_dependencies: True
50+
install_resolver_dependencies: True
51+
52+
tools:
53+
- name: frogs_core
54+
owner: frogs
55+
tool_panel_section_label: FROGS
56+
tool_shed_url: https://toolshed.g2.bx.psu.edu/
57+
- name: frogs_stat
58+
owner: frogs
59+
tool_panel_section_label: FROGS
60+
tool_shed_url: https://toolshed.g2.bx.psu.edu/
61+
- name: frogs_func
62+
owner: frogs
63+
tool_panel_section_label: FROGS
64+
tool_shed_url: https://toolshed.g2.bx.psu.edu/
65+
```
66+
This will create a FROGS section in your Galaxy tool panel, and install or update FROGS wrapper tools.
67+
4768
# Upload and configure the databanks
4869

4970
Databanks are defined in `loc` files and `loc` files are defined in Galaxy datatable.

0 commit comments

Comments
 (0)