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

Updated documentation with FAQ section to respond to user comments. #5755

Merged
merged 1 commit into from
Mar 5, 2019

Conversation

jonn-smith
Copy link
Collaborator

Quick update to docs to include an FAQ section with the first common question populated.

Already pushed to forum.

Copy link
Contributor

@LeeTL1220 LeeTL1220 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jonn-smith Go for it. Nice improvements. Thanks.

## 3 - FAQ
### Why do I not get annotations from my favorite data source on my favorite variant?
This almost always happens when the data source does not overlap the variant. Commonly a variant that is not within a gene will not be annotated by data sources because they are not in the region that the data sources cover (e.g. when the `VariantClassification` is `IGR`, `FIVE_PRIME_FLANK`, `COULD_NOT_DETERMINE`, etc.).
This can also happen if the given reference file does not match the data sources' reference (for the pre-packaged data sources either `hg19`/`b37` or `hg38`). In this case, Funcotator will produce a large obnoxious warning:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this comment.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:D

@jonn-smith jonn-smith merged commit caad1bb into master Mar 5, 2019
@jonn-smith jonn-smith deleted the jts_funcotator_tutorial_info_update branch March 5, 2019 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants