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

Naming of "contig" module and type #10

Open
holtgrewe opened this issue Sep 1, 2020 · 1 comment
Open

Naming of "contig" module and type #10

holtgrewe opened this issue Sep 1, 2020 · 1 comment

Comments

@holtgrewe
Copy link

I think the contig module and Contig struct have a naming issue. From my understanding, "contig" is a well-established term from genome assembly that describes a contiguously assembled sequence. This is, e.g., supported by the contig header in VCF... Also, I believe genome::AbstractInterval::contig shares the description.

What about renaming this as "linear"?

@dlaehnemann
Copy link
Member

I agree. I stumbled upon this naming during the rust-bio Docathon in some code using the Contig. What is described as a contig in contig.rs is rather an interval on some reference sequence (and this reference sequence could more aptly be referred to as a contig...). The Contig struct does not include the sequence itself.

So it should definitely get a clearer name. What about stranded_contig_interval? A bit long, but it captures all the properties. Or maybe just contig_interval?

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

No branches or pull requests

2 participants