Document potential differences in annotation tool version
Open
Beginner friendly
Nobody has claimed this yet.
bug
- Dominant language
- Nextflow
- Stars
- 12
- Forks
- 6
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 8
Description
Description of the bug
If a library of annotated genomes exists when the pipeline starts, there is no guarantee that they were annotated with the same version of Bakta or Prokka. Make this clear in the documentation.
Or: Scan logs for versions for all genomes that were mapped to.
Command used and terminal output
Relevant files
No response
System information
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No relevant files are identified in the issue. Locate the pipeline documentation covering libraries of annotated genomes, then document that existing annotations may have been produced with different Bakta or Prokka versions; the documentation should clearly state this limitation and the possible alternative of scanning logs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100