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

[FEATURE REQUEST] See external/third-party dependencies on program documentation pages #2299

Open
ivagljiva opened this issue Jul 9, 2024 · 1 comment

Comments

@ivagljiva
Copy link
Contributor

A small project to improve anvi'o, based upon feedback/ideas @FlorianTrigodet and I heard from our colleagues at the QIB in Norwich.

The need

We already have a great documentation system integrated into anvi'o that automatically tracks links between programs, artifacts, and workflows. We could extend this system to also keep track of third-party software used within each anvi'o program (for instance, MUSCLE or DIAMOND or Prodigal), so that this information is clearly findable on our help pages (rather than only shown in the occasional CITATION message in terminal output).

The solution

We could add a new type of node in the anvi'o network to represent external dependencies. These could be tracked with something similar to the __requires__ attribute at the top of each program binary, and then automatically parsed into their own section at the top of the program help page.

Beneficiaries

Those who want more transparency about what anvi'o is doing under the hood without actually having to run a program first.

@meren
Copy link
Member

meren commented Jul 9, 2024

We have a similar solution for anvi'o workflows -- see an example here for third-party tools used:

https://anvio.org/help/main/workflows/ecophylo/

Perhaps we can use this mechanism also in programs :)

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

No branches or pull requests

2 participants