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

improving tool documentation & adding tests #383

Open
ewissel opened this issue Jun 4, 2024 · 1 comment
Open

improving tool documentation & adding tests #383

ewissel opened this issue Jun 4, 2024 · 1 comment
Labels
enhancement Improvement for existing functionality

Comments

@ewissel
Copy link

ewissel commented Jun 4, 2024

Description of feature

Hi nf-core team,

Some of the current documentation around tool usage for nf-core/funcscan is a bit ambigious, leading to confusion around parameter usage. For example, for flag --amp_hmmsearch_models, it is not clear that the database path should be in quotes, or for --bgc_hmmsearch_models, it is not clear where the database path needs to point (include subdirectories? full path to files with wildcard?).

Further, some of these tools have long run times or spit out meaningless error messages when the database path is different from what is expected. It'd be good to have some more internal tests here to make sure the path looks as expected. This is also discussed on the slack channel, so discussion can be found there.

Thanks for all the work you do to create and maintain this workflow.

@ewissel ewissel added the enhancement Improvement for existing functionality label Jun 4, 2024
@jasmezz
Copy link
Collaborator

jasmezz commented Jul 18, 2024

  • HMM model files: right now the documentation should be clear. I just added one more sentence regarding the usage of absolute paths for the hmm model files.
  • output meaningful database errors: not addressed yet

@jasmezz jasmezz mentioned this issue Jul 18, 2024
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement for existing functionality
Projects
None yet
Development

No branches or pull requests

2 participants