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

Plans to add an API #69

Open
gtonkinhill opened this issue Dec 4, 2024 · 2 comments
Open

Plans to add an API #69

gtonkinhill opened this issue Dec 4, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@gtonkinhill
Copy link

Hi, thanks very much for building such a useful program!

I was wondering if you had plans to add a c or python API similar to minimap2?

lh3 added a commit that referenced this issue Dec 5, 2024
@lh3
Copy link
Owner

lh3 commented Dec 5, 2024

The C APIs are mostly ready but need documentations and an example. I have just added those in 7153f15. These APIs are close to minimap2's. Nonetheless, because miniprot CIGAR is more complex. You will probably feel more difficult to extract information. Ideally, it would be good to add new APIs to process CIGAR (e.g. generating a cs string with all the mismatches and gaps), but this will take time – they are not there yet. For now you can have a look at format.c. Implementing Python APIs will take more efforts. I will see if more users are interested in this.

@gtonkinhill
Copy link
Author

That's great, thank you very much! I'll take a look at the C APIs.

@lh3 lh3 added the enhancement New feature or request label Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants