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

feat: Add longtr support #232

Merged
merged 9 commits into from
Sep 20, 2024
Merged

feat: Add longtr support #232

merged 9 commits into from
Sep 20, 2024

Conversation

gymreklab
Copy link
Contributor

@gymreklab gymreklab commented Aug 30, 2024

This PR adds explicit support for LongTR VCF files, meaning most commands will now accept --vcftype longtr. Because LongTR is an extension of HipSTR for long reads, the format is very similar to HipSTR and some HipSTR functions are reused. The main difference is the stutter fields are not present.

In fact, in most cases giving a LongTR VCF but specifying --vcftype hipstr should still work fine.

Checklist

  • [x ] I've checked to ensure there aren't already other open pull requests for the same update/change
  • [ x] I've prefixed the title of my PR according to the conventional commits specification. If your PR fixes a bug, please prefix the PR with fix: . Otherwise, if it introduces a new feature, please prefix it with feat: . If it introduces a breaking change, please add an exclamation before the colon, like feat!: . If the scope of the PR changes because of a revision to it, please update the PR title, since the title will be used in our CHANGELOG.
  • [x ] At the top of the PR, I've listed any open issues that this PR will resolve. For example, "resolves #0" if this PR resolves issue #0
  • [x ] I've explained my changes in a manner that will make it possible for both users and maintainers of TRTools to understand them
  • [x ] I've added tests for any new functionality. Or, if this PR fixes a bug, I've added test(s) that replicate it
  • [x ] All directories with large test files are listed in the "exclude" section of our pyproject.toml so that they do not appear in our PyPI distribution. All new files are also smaller than 0.5 MB.
  • [ x] I've updated the relevant REAMDEs with any new usage information and checked that the newly built documentation is formatted properly
  • [ x] All functions, modules, classes etc. still conform to numpy docstring standards
  • [ x] (if applicable) I've updated the pyproject.toml file with any changes I've made to TRTools's dependencies, and I've run poetry lock --no-update to ensure the lock file stays up to date and that our dependencies are locked to their minimum versions
  • [ x] In the body of this PR, I've included a short address to the reviewer highlighting one or two items that might deserve their focus

Copy link
Contributor

⚠️ Possible file(s) that should be tracked in LFS detected ⚠️

    The following file(s) exceeds the file size limit: 500000 bytes, as set in the .yml configuration files:

    trtools/testsupport/sample_vcfs/associaTR/many_samples_biallelic_dosages.vcf.gz

    Consider using git-lfs to manage large files.

@github-actions github-actions bot added the large-files Warning Label for use when LFS is detected in the commits of a Pull Request label Aug 30, 2024
@github-actions github-actions bot removed the large-files Warning Label for use when LFS is detected in the commits of a Pull Request label Aug 30, 2024
@gymreklab gymreklab marked this pull request as ready for review August 30, 2024 05:01
@gymreklab gymreklab requested a review from heliziii August 30, 2024 05:02
doc/CALLERS.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@heliziii heliziii left a comment

Choose a reason for hiding this comment

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

Hi Melissa, I went through your changes and all is good. Thank you.

@gymreklab gymreklab merged commit 93ff231 into master Sep 20, 2024
13 checks passed
@gymreklab gymreklab deleted the add-longtr-support branch September 20, 2024 23:11
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