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

Initial commit of Teloscope #6556

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

AldhairMedico
Copy link

FOR CONTRIBUTOR:

  • I have read the CONTRIBUTING.md document and this tool is appropriate for the tools-iuc repo.
  • License permits unrestricted use (educational + commercial)
  • This PR adds a new tool or tool collection
  • This PR updates an existing tool or tool collection
  • This PR does something else (explain below)

@bernt-matthias bernt-matthias marked this pull request as draft November 13, 2024 13:51
@bernt-matthias
Copy link
Contributor

In order to get the tests running here you need to add a .shed.yaml file.

</xml>
<token name="@TOOL_VERSION@">0.0.5</token>
<token name="@VERSION_SUFFIX@">0</token>
<token name="@PROFILE@">21.05</token>
Copy link
Contributor

Choose a reason for hiding this comment

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

I would prefer something in the range of 23.0 or 23.2

<token name="@PROFILE@">21.05</token>
<xml name="citations">
<citations>
<citation type="bibtex">
Copy link
Contributor

Choose a reason for hiding this comment

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

No publication?

@@ -0,0 +1,108 @@
<tool id="teloscope" name="Teloscope" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
<description>is a fast and comprehensive tool for matching, counting, and reporting telomeric repeats from genome assemblies.</description>
Copy link
Contributor

Choose a reason for hiding this comment

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

Please keep the description as short as possible: analyze telomeric repeats

</macros>
<expand macro="requirements"/>
<command detect_errors="exit_code"><![CDATA[
mkdir -p output &&
Copy link
Contributor

Choose a reason for hiding this comment

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

Indentation seems off

<param argument="--verbose" type="boolean" truevalue="--verbose" falsevalue="" checked="false" label="Verbose output"/>
</inputs>
<outputs>
<data name="canonical_matches" format="bed" from_work_dir="output/canonical_matches.bed" label="Canonical matches from ${on_string}">
Copy link
Contributor

Choose a reason for hiding this comment

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

There are quite a few outputs. Can some of them be optional? I would prefer labels of the form ${tool.name} on ${on_string}: ...

]]></command>
<inputs>
<param argument="--input-sequence" type="data" format="fasta,fasta.gz" label="Input assembly"/>
<param argument="--canonical" type="text" value="TTAGGG" label="Canonical pattern">
Copy link
Contributor

Choose a reason for hiding this comment

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

What is a canonical pattern?

<valid initial="string.ascii_letters"/>
</sanitizer>
</param>
<param argument="--patterns" type="text" value="TTAGGG" label="Patterns to explore, separated by commas">
Copy link
Contributor

Choose a reason for hiding this comment

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

Indentation.

<param argument="--input-sequence" type="data" format="fasta,fasta.gz" label="Input assembly"/>
<param argument="--canonical" type="text" value="TTAGGG" label="Canonical pattern">
<sanitizer invalid_char="">
<valid initial="string.ascii_letters"/>
Copy link
Contributor

Choose a reason for hiding this comment

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

Can be more specific than ASCII letters, or?

</test>
</tests>
<help><![CDATA[
teloscope [commands]
Copy link
Contributor

Choose a reason for hiding this comment

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

Would prefer not to have just command line help.

I get more and more reluctant to include completely undescribed software (at least I found no docs), I understand that this software comes from a respectful source. And probably users don't care anyway as long as the software does what they expect.

It's unsatisfying.

We should at the very least open an upstream issue that some docs would be nice.

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

Successfully merging this pull request may close these issues.

2 participants