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

The VCF combine chromosomes operation should be callled "concat", not "merge" #9

Closed
RamRS opened this issue Aug 10, 2020 · 4 comments
Closed
Assignees
Labels
enhancement New feature or request

Comments

@RamRS
Copy link

RamRS commented Aug 10, 2020

It is common convention across popular tools such as the VCFtools PERL library and bcftools to differentiate between

  1. combining chromosome-specific VCF files into a single VCF file; and
  2. combining single sample VCF files into one multi-sample VCF file

The former is called concat and the latter, merge. However, in your tookit, you call the former merge, which is misleading. Plus, given that your README does not describe what the operation actually does, one needs to dig deep to understand what's going on.

Please rename the operation and add a line in the README addressing this.

@reneshbedre reneshbedre added the enhancement New feature or request label Aug 10, 2020
@reneshbedre
Copy link
Owner

Hi @RamRS,

Thank you for your recommendations. I would consider changing the function name from merge to concat to keep with the conventional names.

@reneshbedre
Copy link
Owner

This issue has been fixed in v0.9.4

@reneshbedre reneshbedre self-assigned this Aug 13, 2020
@RamRS
Copy link
Author

RamRS commented Aug 13, 2020

That was really quick! If you consider switching to pysam to read high throughput files (BAM, VCF, etc), let me know - I'm willing to contribute.

@reneshbedre
Copy link
Owner

@RamRS ,

Thank you for showing an interest in bioinfokit. It would be a good idea to use pysam, but it is highly dependent on other non-Python tools. If you have something that is in Python and adds value to bioinfokit, you are always welcome to contribute.

Thank you.

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