fix: making the TSSDistance behaviour consistent #806
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 problem
Currently if users extract distances from TSS for both directions (
-plugin TSSDistance,both_direction=1), the value of downstream distances are negative. This behaviour is not consistent how distance is reported, where all reported distance is positive irrespective if the variant is up or downstream.This PR allows users to provide and extra parameter to the
TSSDistanceplugin (signed_distance=1), which would allow for negative values, otherwise (by default) only positive distance is returned.Testing
I picked
"chr4:1804392 G/A", a missense variant for testing, which has a downstream position from the TSS of the overlapping gene. What I got with different runs:--plugin TSSDistance: no tss distance is in the output, as the default behaviour prevents that.--plugin TSSDistance,both_direction=1:"tssdistance": 11099positive distance however downstream position.--plugin TSSDistance,both_direction=1,signed_distance=1:"tssdistance": -11099,the distance value is signed.Please take a look and let me know if there's something wrong with my thought process.