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 EMBOSS 6: fuzznuc #4347

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

innovate-invent
Copy link
Contributor

@innovate-invent innovate-invent commented Jan 25, 2022

It looks like people keep starting to implement automated EMBOSS 6 wrapper solutions but then abandoning them. I propose a more manual peace-meal approach based on interest.

I have created a new folder for emboss 6 given that the current emboss folder has its version number baked in. For future versions of emboss we can then reuse this folder. I have also removed special characters from the tool ID to improve compatibility with downstream scripts. The perl dependency was removed. I think it would be best to avoid extra dependencies if possible, removing the need for a special mulled container.

New parameters for fuzznuc have been included.

Some work should be done to remove the emboss_format_corrector.py but this appears like it might be non-trivial.
emboss_format_corrector.py was outdated and removed

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)

Related #131

@innovate-invent
Copy link
Contributor Author

The test failure says to check the artifacts but I don't see any...

@wm75
Copy link
Contributor

wm75 commented Feb 2, 2022

The test failure says to check the artifacts but I don't see any...

They are a bit hard to discover nowadays: click on "Summary" in the navigation bar on the left of the Action page. The Artifacts are at the very bottom of that section.

Copy link
Contributor

@bernt-matthias bernt-matthias left a comment

Choose a reason for hiding this comment

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

Maybe we can add a todo list to this old issue #65 .. keeping track of updating all the emboss tools?

@@ -0,0 +1,133 @@
<tool id="emboss_fuzznuc37" name="fuzznuc" version="6.6.0">
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you use to version token here? And maybe rename to TOOL_VERSION?

Copy link
Contributor

Choose a reason for hiding this comment

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

In there a reason for 37 in the id?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure, I have no idea why the 37. It was copied from emboss_5.

Copy link
Contributor

Choose a reason for hiding this comment

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

Now I see. I did non get in the first place that you created a new folder.

With the change of the id we are destroying tool lineare (I guess) .. but keeping the space and upper case letters also seems to be no good option?

I guess we need someone here who knows better about tool lineage...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This will be published to a new tool repo and will not have the same lineage as emboss_5.
The only way to have it in the same lineage would be to have emboss 6 in the emboss_5 repo.

Copy link
Member

Choose a reason for hiding this comment

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

The only way to have it in the same lineage would be to have emboss 6 in the emboss_5 repo.

True, as far I as I understand, tool lineage is maintained only if also the ToolShed owner and repository name are the same (i.e. the whole guid minus the version).

This will be published to a new tool repo and will not have the same lineage as emboss_5.

As you've already noticed, 3 years ago I updated one tool in emboss_5 to v6.6.0 to keep the lineage. I see 2 alternative options here:

  1. Keep updating (or adding) tools in the emboss_5 directory.
    Pros: preserve the lineage of the existing tools
    Cons: the emboss_5 repository becomes increasingly a misnomer; all-in-one repository
  2. Create a new emboss_suite suite with a separate repository for each new/updated tool and sane tool IDS (like in this PR, but you would need to modified the .shed.yml like in https://github.com/galaxyproject/tools-iuc/blob/master/tools/bcftools/.shed.yml )
    Pros: one tool per repository; sane tool IDs; no "5" in the repo names
    Cons: tool lineages broken, i.e. no clean upgrade path for workflows using these tools

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is there value in a suite if it is all the same dependency?

I am not sure that there would be a clean upgrade path for workflows sticking with the emboss_5 repo. There are going to be a lot of incompatible changes in the major version bump of the tools.

Copy link
Member

Choose a reason for hiding this comment

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

Is there value in a suite if it is all the same dependency?

I'll leave this one for @mvdbeek to reply :)

tools/emboss/emboss_fuzznuc.xml Show resolved Hide resolved
tools/emboss/macros.xml Outdated Show resolved Hide resolved
<yield />
</citations>
</xml>
<xml name="regex_sanitizer">
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems unused.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Macros were copied forward from emboss_5 if anyone wants to reuse them for other tools. I can remove them if you think it isn't worth it.

tools/emboss/.shed.yml Outdated Show resolved Hide resolved
tools/emboss/.shed.yml Outdated Show resolved Hide resolved
innovate-invent and others added 2 commits February 9, 2022 14:09
Co-authored-by: Nicola Soranzo <nicola.soranzo@gmail.com>
Co-authored-by: Nicola Soranzo <nicola.soranzo@gmail.com>
@bgruening
Copy link
Member

What is the status here @nsoranzo and @bernt-matthias? This will be deployed as IUC. I guess the idea is to deprecate the devteam tools?

@bernt-matthias
Copy link
Contributor

Main/Last question is tool lineage.

Wondering if we can just mix versions in the old dir. Given that emboss has seen no updates in a long time (http://emboss.sourceforge.net/developers/changelog.html) we can hope that the tools will converge to the latest at one point.

Has someone ever tried to bump emboss?

@bgruening
Copy link
Member

The old tools are all in one repo aren't they?

@bernt-matthias
Copy link
Contributor

The old tools are all in one repo aren't they?

yes

Has someone ever tried to bump emboss?

remember that there are barely any tests...

@bernt-matthias bernt-matthias mentioned this pull request Jan 19, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants