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

📚 update docs for genotype filtering #57

Merged
merged 2 commits into from
Jan 8, 2025

Conversation

dmiller15
Copy link
Collaborator

@dmiller15 dmiller15 commented Dec 19, 2024

Description

Updating the docs and pub app formatting for the genotyping workflow.

Part of https://d3b.atlassian.net/browse/BIXU-3800

Type of change

  • Documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Nothing to test

Test Configuration:

  • Environment:
  • Test files:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings
  • I have committed any related changes to the PR

@dmiller15 dmiller15 added documentation Regarding developer or user documentation bix-dev This issue or pull request is bix-dev work labels Dec 19, 2024
@dmiller15 dmiller15 self-assigned this Dec 19, 2024
Copy link
Member

@migbro migbro left a comment

Choose a reason for hiding this comment

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

Looks pretty good overall, a couple small questions and comments

small-scale experiments, such as targeted gene panels or exome studies with
fewer than 30 exomes." Therefore, VQSR is only activated in this workflow when
the input gVCFs for this workflow come from whole genome sequencing experiments
or when the user provides 30 or more exome gVCFs.
Copy link
Member

Choose a reason for hiding this comment

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

If you provide 30+ exomes, target, do you get a joint called VCF, or individual calls with VQSR?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

They all get jointly processed. 30+ exomes will go to VQSR, 30+ targeted will still be hard filtered.

Targeted seq just is too high depth and too low data to work properly in VQSR.

Hard Filtering is really only constrained by having sufficient depth. In the
case of exome and targeted sequencing, the depths are more than sufficient. Our
current approach for hard filtering mirrors the default approach outlined in
the GATK documentation. However as they point out, "You absolutely SHOULD
Copy link
Member

Choose a reason for hiding this comment

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

Is there link to the various filtering possibilities/syntax?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There are but they are GATK doc links, which means they'll just end up dead sooner or later.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm debating making archive links to everything, but in the ticket.

@dmiller15 dmiller15 force-pushed the dm-update-genotyping-docs branch from bea6e65 to 60db58d Compare December 20, 2024 14:54
@dmiller15 dmiller15 merged commit 4410f6b into dm-exome-panel-genotyping Jan 8, 2025
1 check passed
@dmiller15 dmiller15 deleted the dm-update-genotyping-docs branch January 8, 2025 15:02
dmiller15 added a commit that referenced this pull request Jan 8, 2025
* 🚧 restrucutre genotyping wf

* 🚧 rework fitlering and defaults

* 🚧 rework hardfiltering

🐛 fix typos

🧹 cleanup unused tools

🧹 return old output name

* 🔧 update snv ports for genotyping

* update docker table (#56)

Co-authored-by: dmiller15 <[email protected]>

* 📚  update docs for genotype filtering (#57)

* 📚 update docs for genotype filtering

* 📚 clarify docs

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bix-dev This issue or pull request is bix-dev work documentation Regarding developer or user documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants