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

Adding arg to VariantFiltration to write your own description in Header #8831

Merged
merged 4 commits into from
May 15, 2024

Conversation

meganshand
Copy link
Contributor

This allows the user to write their own description in the FILTER line in the header. Currently a user can define an interval list to filter with and name that filter, but the description line is always "Doesn't overlap a user-input mask" or "Overlaps a user-input mask", whereas it might be more useful to let the user provide a more detailed description (for example, "Outside of sequencing target intervals").

@meganshand
Copy link
Contributor Author

@droazen could you please suggest a reviewer?

@droazen droazen self-assigned this May 15, 2024
@droazen droazen self-requested a review May 15, 2024 18:13
Copy link
Collaborator

@droazen droazen left a comment

Choose a reason for hiding this comment

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

Looks good to me @meganshand -- just one minor comment on naming

@@ -114,6 +114,7 @@ public final class VariantFiltration extends VariantWalker {
public static final String CLUSTER_WINDOW_SIZE_LONG_NAME = "cluster-window-size";
public static final String MASK_EXTENSION_LONG_NAME = "mask-extension";
public static final String MASK_NAME_LONG_NAME = "mask-name";
public static final String MASK_DESCRIPTION_LONG_NAME = "mask-desc";
Copy link
Collaborator

Choose a reason for hiding this comment

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

I might spell out mask-description for this argument name, since the other mask arguments don't have abbreviations

@droazen droazen merged commit a3bbfc4 into master May 15, 2024
17 checks passed
@droazen droazen deleted the ms_filter_doc branch May 15, 2024 20:43
mcovarr pushed a commit that referenced this pull request Jul 1, 2024
…in VCF header (#8831)

Added a --mask-description argument to VariantFiltration to write a custom description for the mask filter in the VCF header
mcovarr pushed a commit that referenced this pull request Jul 10, 2024
…in VCF header (#8831)

Added a --mask-description argument to VariantFiltration to write a custom description for the mask filter in the VCF header
mcovarr pushed a commit that referenced this pull request Jul 15, 2024
…in VCF header (#8831)

Added a --mask-description argument to VariantFiltration to write a custom description for the mask filter in the VCF header
mcovarr pushed a commit that referenced this pull request Jul 19, 2024
…in VCF header (#8831)

Added a --mask-description argument to VariantFiltration to write a custom description for the mask filter in the VCF header
mcovarr pushed a commit that referenced this pull request Jul 19, 2024
…in VCF header (#8831)

Added a --mask-description argument to VariantFiltration to write a custom description for the mask filter in the VCF header
mcovarr pushed a commit that referenced this pull request Jul 22, 2024
…in VCF header (#8831)

Added a --mask-description argument to VariantFiltration to write a custom description for the mask filter in the VCF header
mcovarr pushed a commit that referenced this pull request Jul 23, 2024
…in VCF header (#8831)

Added a --mask-description argument to VariantFiltration to write a custom description for the mask filter in the VCF header
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

Successfully merging this pull request may close these issues.

2 participants