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

"Ancestral state" or "ancestral allele"? #971

Closed
hyanwong opened this issue Sep 5, 2024 · 2 comments
Closed

"Ancestral state" or "ancestral allele"? #971

hyanwong opened this issue Sep 5, 2024 · 2 comments

Comments

@hyanwong
Copy link
Member

hyanwong commented Sep 5, 2024

When we create a VariantData class, we specify ancesteral_allele as an array of strings. However, when we return the sites_ancestral_allele array, it is a numpy array of indexes into the alleles list. It's a bit confusing to use "ancestral_allele to mean a string in one context, and a numerical index in another

When devising the SampleData class, we took care to describe the ancestral strings as "ancestral states", and used "ancestral allele" to refer to an index into the alleles list (there is some discussion about this on GitHub somewhere, but I can't dig it up). Should we therefore rename the second argument of VariantData(...) to ancestral_state? This would match the tskit terminology, which is nice (but note that the VCF info fields tend to use AA as an abbreviation for "Ancestral Allele", referring to a string, so perhaps we can't win).

@benjeffery
Copy link
Member

I don't have a strong opinion here. I guess tsinfer should be consistent though.

@hyanwong
Copy link
Member Author

Fixed in #963

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