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

Documentation for custom annotation databases #5

Open
dutchscientist opened this issue Feb 5, 2023 · 2 comments
Open

Documentation for custom annotation databases #5

dutchscientist opened this issue Feb 5, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@dutchscientist
Copy link

Am trying this, first attempt with a personal training set looks good, although I personally like the way I can control annotation with Prokka, but this is more convenient. But straight away a question:

Is there any documentation of how an annotation database should look? I tried one I have used for Prokka (which uses ~~~ between text bits in the header), and that didn't work.

Prokka has an easy way to make databases from annotated genome sequences, any tips on how this for ggCaller?
https://github.com/tseemann/prokka#adding-a-genus-databases
https://github.com/tseemann/prokka#fasta-database-format

Thanks :)

@samhorsfield96
Copy link
Collaborator

Hi, there's no strict requirement for annotation headings. The descriptions provided in the header of the annotation fasta file will be appended to respective clusters they align to. However, I'd suggest avoiding special character's like "~~~" as these are used to separate multiple annotations assigned to merged clusters in ggCaller. Thanks for bringing this up though - it's an important point and something we'll look into.

@samhorsfield96 samhorsfield96 added the documentation Improvements or additions to documentation label Feb 6, 2023
@dutchscientist
Copy link
Author

Thanks. So probably best to search and replace the ~~~; the way Prokka makes the databases is nice and easy, so wouldn't like to lose it.

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

No branches or pull requests

2 participants