[vds] fix impute_sex_chromosome_ploidy docs #11452
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
patrick-schultz
requested changes
Mar 3, 2022
hail/python/hail/vds/methods.py
Outdated
Comment on lines
374
to
376
| - ``x_ploidy`` (*float64*): Estimated ploidy on X chromosome. Equal to ``x_mean_dp / autosomal_mean_dp * 2``. | ||
| - ``y_mean_dp`` (*float64*): Mean depth on calling intervals on chromosome. | ||
| - ``y_ploidy`` (*float64*): Estimated ploidy on Y chromosome. Equal to ``2 * autosomal_mean_dp / y_mean_dp``. | ||
| - ``y_ploidy`` (*float64*): Estimated ploidy on Y chromosome. Equal to ``y_mean_db / autosomal_mean_dp * 2``. |
There was a problem hiding this comment.
This associates as (x_mean_dp / autosomal_mean_dp) * 2, right? Could you write it 2 * x_mean_dp / autosomal_mean_dp so there's no ambiguity?
the actual expression for x/y ploidy is:
```python3
per_sample = coverage.transmute_cols(autosomal_mean_dp=auto_dp,
x_mean_dp=x_dp,
x_ploidy=2 * x_dp / auto_dp,
y_mean_dp=y_dp,
y_ploidy=2 * y_dp / auto_dp)
```
chrisvittal
force-pushed
the
vds/fix-impute-sex-docs
branch
from
eabd145
to
1fa9f01
Compare
patrick-schultz
approved these changes
Mar 3, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
the actual expression for x/y ploidy is: