Skip to content

Commit

Permalink
Update docs (galaxyproject#51)
Browse files Browse the repository at this point in the history
* update flowchart

* add new flowchart figure and use in readme

* readme

* update readme (galaxyproject#48)

* Update docs (galaxyproject#50)

* update readme

* update readme
  • Loading branch information
paulzierep authored Jan 24, 2024
1 parent ea70041 commit 26a2765
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ Galaxy Tool Metadata Extractor

![plot](docs/images/Preprint_flowchart.png)


This tool automatically collects a table of all available Galaxy tools including their metadata. The created table
can be filtered to only show the tools relevant for a specific community. **Learn [how to add your community](#add-your-community)**.

The tools performs the following steps:

- Parse tool GitHub repository from [Planemo monitor listed](https://github.com/galaxyproject/planemo-monitor)
- Check in each repo, their `.shed.yaml` file and filter for categories, such as metagenomics
- Extract metadata from the `.shed.yaml`
Expand All @@ -13,6 +19,10 @@ Galaxy Tool Metadata Extractor
- Extract bio.tools information if available in the macros or xml
- Check available on the 3 main galaxy instances (usegalaxy.eu, usegalaxy.org, usegalaxy.org.au)
- Get usage statistics form usegalaxy.eu
- Creates an interactive table for all tools: [All tools](https://galaxyproject.github.io/galaxy_tool_metadata_extractor/)
- Creates an interactive table for all registered communities, e.g. [microGalaxy](https://galaxyproject.github.io/galaxy_tool_metadata_extractor/microgalaxy/)



# Usage

Expand Down Expand Up @@ -93,3 +103,15 @@ The script will generate a TSV file with each tool found in the list of GitHub r
[--keep <Path to to-keep tool file category file>]
```
## Add your community
In order to add your community you need to:
- Fork this repository.
- Add a folder for your community in `data/communities`.
- Add at least the file `categories`.
- Add all `categories` that are relevant to initially filter the tools for your community. Possible categories are listed here [Galaxy toolshed](https://toolshed.g2.bx.psu.edu/).
- Make a pull request to add your community.
- The workflow will run every sunday, so on the next monday, your community table should be added to `results/<your community name>`

0 comments on commit 26a2765

Please sign in to comment.