Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sylph tool Wrapper #1518

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions tools/sylph/.shed.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: sylph
owner: iuc
tcollins2011 marked this conversation as resolved.
Show resolved Hide resolved
description: ANI querying and metagenomic profiling
tcollins2011 marked this conversation as resolved.
Show resolved Hide resolved
long_description: sylph is a program that performs ultrafast (1) ANI querying or (2) metagenomic profiling for metagenomic shotgun samples.
homepage_url: https://github.com/bluenote-1577/sylph
remote_repository_url: https://github.com/galaxyproject/tools-iuc/
tcollins2011 marked this conversation as resolved.
Show resolved Hide resolved
categories:
- Metagenomics
type: unrestricted
auto_tool_repositories:
name_template: "{{ tool_id }}"
description_template: "{{ tool_name }} from the sylph suite"

10 changes: 10 additions & 0 deletions tools/sylph/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
For Galaxy admins and local runs:

The databases for sylph have associated metadata files. These files MUST be paired with the correct databases to output correctly. Here is the easiest location to download databases and metadata files:
For databases: https://github.com/bluenote-1577/sylph/wiki/Pre%E2%80%90built-databases
For metadata: https://github.com/bluenote-1577/sylph-utils

The tool assumes the directory the data_table references to be
<name_of_organism>
- database.syldb
- metadata.tsv.gz
55 changes: 55 additions & 0 deletions tools/sylph/macros.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<macros>
<token name="@TOOL_VERSION@">0.6.1</token>
<token name="@VERSION_SUFFIX@">0</token>
<token name="@LICENSE@">MIT</token>
<xml name="requirements">
<requirements>
<requirement type="package" version="@TOOL_VERSION@">sylph</requirement>
<requirement type="package" version="3.11.9">python</requirement>
<requirement type="package" version="2.2.3">pandas</requirement>
Comment on lines +101 to +102
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<requirement type="package" version="3.11.9">python</requirement>
<requirement type="package" version="2.2.3">pandas</requirement>
<requirement type="package" version="3.11">python</requirement>
<requirement type="package" version="2.2">pandas</requirement>

</requirements>
</xml>
<xml name="description">
<description>Metagenomic assignments</description>
tcollins2011 marked this conversation as resolved.
Show resolved Hide resolved
</xml>
<xml name="citation">
<citations>
<citation type="doi">10.1101/2023.11.20.567879</citation>
tcollins2011 marked this conversation as resolved.
Show resolved Hide resolved
</citations>
</xml>
<xml name="creator">
<creator>
<organization name="University of Toronto" url="https://github.com/bluenote-1577/sylph"/>
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is meant to acknowledge you, the Galaxy tool creator.

</creator>
</xml>
<xml name="xrefs">
<xrefs>
<xref type="bio.tools">sylph</xref>
</xrefs>
</xml>
<xml name="input_database">
<conditional name="database_select">
<param name="select" type="select" label="Choose the source for databases and metadata">
<option value="cached">Cached data</option>
<option value="history">History</option>
</param>
<when value="cached">
<param label="Select a sylph database" name="sylph_database" type="select">
<options from_data_table="sylph_databases">
<validator message="No Sylph databases are available" type="no_options" />
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add here a filter for version 1 or something like that ... and then we include version 1 in the test file.

Whenever the tool changes to DB layout we increase this version.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping, you are not filtering the DB here according to the version

</options>
</param>
</when>
<when value="history">
<param label="Select a history dataset" name="sylph_database" type="data" format="binary" />
<param label="Metadata file for metaphlan and krona outputs" name="metadata" type="data" format="tabular.gz" optional="true" help="The metata file MUST be directly associated with the input database. For more information, view the help text of the tool."/>
</when>
</conditional>
</xml>
<xml name="output_format">
<param label="Additional output formats" name="outputs" type="select" display="checkboxes" multiple="true" help="In addition to Sylph's tabular output, you may ouput a file converted to these formats">
<option value="metaphlan">Sylph's MetaPhlAn-like output</option>
<option value="krona">Krona compatible</option>
</param>
</xml>
</macros>
Loading
Loading