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

Error and generally confusion docs wrt "variables calculated on the fly" for expressions #164

Closed
travc opened this issue Dec 1, 2014 · 2 comments

Comments

@travc
Copy link
Contributor

travc commented Dec 1, 2014

The section in the docs about "variables calculated on the fly" under EXPRESSIONS has some problems...

Current text:

variables calculated on the fly if not present: number of alternate alleles; number of samples; number of alternate alleles; minor allele count (similar to AC but is always smaller than 0.5); frequency of alternate alleles (AF=AC/AN); frequency of minor alleles (MAF=MAC/AN); number of alleles in called genotypes

N_ALT, N_SAMPLES, AC, MAC, AF, MAF, AN

The second "number of alternate alleles" is an error... should be "count of alternate alleles" I think.
But that is still pretty opaque.

What exactly is "minor allele"? Is it all the alleles other than the most frequent one (should be IMO)? Is MAC the sum of the minor alleles, just the most frequent of the minor alleles, or just the least frequent (the answer should be the sum IMO)?

As for that confusing part of the docs...
I'd suggest making a list with a symbol (N_ALT, N_SAMPLES, ect.) and it's definition as the elements.

@pd3 pd3 closed this as completed in 54b9043 Dec 16, 2014
@BaxW
Copy link

BaxW commented Nov 27, 2024

I still find this section of the documentation confusing. How can MAC be "always smaller than 0.5" if it is a count?

@pd3
Copy link
Member

pd3 commented Dec 3, 2024

The wording needs to be fixed. Obviously, 0.5 is supposed to refer to allele frequencies, integer numbers to counts, AF vs AC.

pd3 added a commit that referenced this issue Dec 3, 2024
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

3 participants