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

add new tool tiara #1428

Merged
merged 12 commits into from
May 29, 2024
Merged

add new tool tiara #1428

merged 12 commits into from
May 29, 2024

Conversation

Minamehr
Copy link
Contributor

Hi,
This pull request aims to add a new tool, Tiara. It is a deep-learning-based approach for identifying eukaryotic sequences in metagenomic data.

Kind regards,
Mina

@bgruening
Copy link
Owner

Tests are unfortunately failng.

<requirements>
<requirement type="package" version="@TOOL_VERSION@">tiara</requirement>
<requirement type="package" version="3.8">python</requirement>
<yield/>
Copy link
Contributor

@SaimMomin12 SaimMomin12 May 24, 2024

Choose a reason for hiding this comment

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

I think <yield> is just misplaced here?

Comment on lines +31 to +36
#if $cutoff_stage1
-p $cutoff_stage1
#if $cutoff_stage2
$cutoff_stage2
#end if
#end if
Copy link
Contributor

Choose a reason for hiding this comment

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

Is nested if statement done purposefully here?

tools/tiara/tiara.xml Outdated Show resolved Hide resolved
tools/tiara/tiara.xml Outdated Show resolved Hide resolved
tools/tiara/tiara.xml Outdated Show resolved Hide resolved
<param name="first_stage_kmer" type="select" label="Select k-mer length used in the first stage of classification (Default: 6).">
<option value="4">k-mer length 4</option>
<option value="5">k-mer length 5</option>
<option value="6">default k-mer length</option>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<option value="6">default k-mer length</option>
<option value="6" selected="True">default k-mer length</option>

<option value="4">k-mer length 4</option>
<option value="5">k-mer length 5</option>
<option value="6">k-mer length 6</option>
<option value="7">default k-mer length</option>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<option value="7">default k-mer length</option>
<option value="7" selected="True">default k-mer length</option>

tools/tiara/tiara.xml Outdated Show resolved Hide resolved
tools/tiara/tiara.xml Outdated Show resolved Hide resolved
Comment on lines 165 to 167

The tiara is a Deep-learning-based approach for identification of eukaryotic sequences in the metagenomic data powered by PyTorch.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a bit more text about required inputs and generated outputs?

tools/tiara/.shed.yml Outdated Show resolved Hide resolved
tools/tiara/macros.xml Outdated Show resolved Hide resolved
<option value="pro">prokarya</option>
<option value="all">all</option>
</param>
<param name="probabilities" type="boolean" truevalue="--pr" falsevalue="" checked="false" label="Add probabilities of individual classes for each sequence."/>
Copy link
Contributor

@SaimMomin12 SaimMomin12 May 24, 2024

Choose a reason for hiding this comment

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

Maybe changing name to argument is better in this case? This then needs to be changed every place that has an argument.

You can check this wrapper for reference: https://github.com/galaxyproject/tools-iuc/blob/main/tools/pairtools/parse.xml#L33

Copy link
Contributor

@SaimMomin12 SaimMomin12 left a comment

Choose a reason for hiding this comment

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

Hi @Minamehr,

I've had a quick look at the PR and overall looks good. I've commented some of the changes that would be better to incorporate.

Best!

Minamehr and others added 8 commits May 24, 2024 15:03
Co-authored-by: Saim Momin <64724322+SaimMomin12@users.noreply.github.com>
Co-authored-by: Saim Momin <64724322+SaimMomin12@users.noreply.github.com>
Co-authored-by: Saim Momin <64724322+SaimMomin12@users.noreply.github.com>
Co-authored-by: Saim Momin <64724322+SaimMomin12@users.noreply.github.com>
Co-authored-by: Saim Momin <64724322+SaimMomin12@users.noreply.github.com>
Co-authored-by: Saim Momin <64724322+SaimMomin12@users.noreply.github.com>
Co-authored-by: Saim Momin <64724322+SaimMomin12@users.noreply.github.com>
Comment on lines 30 to 32
-p $cutoff_stage1
#if $cutoff_stage2
$cutoff_stage2
Copy link
Contributor

@SaimMomin12 SaimMomin12 May 24, 2024

Choose a reason for hiding this comment

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

Assuming it to be a nested if loop 👍

<option value="all">all</option>
</param>
<param argument="probabilities" type="boolean" truevalue="--pr" falsevalue="" checked="false" label="Add probabilities of individual classes for each sequence."/>
<param argument="verbose" type="boolean" truevalue="-v" falsevalue="" checked="false" label="Display some additional messages and progress bar during classification."/>
Copy link
Owner

Choose a reason for hiding this comment

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

verbose is usually a parameter that should not be exposed to a user I think. You could enable it by default for example or not.

</param>
<param argument="probabilities" type="boolean" truevalue="--pr" falsevalue="" checked="false" label="Add probabilities of individual classes for each sequence."/>
<param argument="verbose" type="boolean" truevalue="-v" falsevalue="" checked="false" label="Display some additional messages and progress bar during classification."/>
<param argument="min_len" type="integer" value="3000" optional="true" label="Minimum length of a sequence. Default: 3000 bp." help="Specify the desired minimum length in base pairs.Default value is 3000 bp and we do not recommend classifying sequences shorter than 1000 bp. "/>
Copy link
Owner

Choose a reason for hiding this comment

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

please consider adding min / max wherever possible.

Copy link
Owner

Choose a reason for hiding this comment

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

@Minamehr there are many more where you can add min/max ;)

@bgruening bgruening merged commit 3e174d7 into bgruening:master May 29, 2024
11 checks passed
@bgruening
Copy link
Owner

Thanks @Minamehr!

@bgruening
Copy link
Owner

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants