jan-glx / hiphase_foss

FOSS version of HiPhase, a small and structural variant phasing tool for PacBio HiFi reads

HiPhase : Phasing tool for PacBio HiFi reads

HiPhase will phase variant calls made from PacBio HiFi datasets. Key features relative to other phasing tools include:

• Joint phasing of small variants and structural variants
• Support for multi-allelic variation
• Creates longer, correct phase blocks relative to the current best practice
• No downsampling of the data
• Novel algorithms: dual-mode allele assignment and core A* phasing algorithm
• Quality of life additions: innate multi-threading, simultaneous haplotagging and statistics generation

Early release warning

Please note that HiPhase is still in early development. We are still tweaking the input / output file formats and making changes that can affect the behavior of the program.

Availability

• Latest release with binary

Documentation

• Installation instructions
• User guide with quickstart
• Output files
• Methods
• Performance

Citation

If you use HiPhase, please cite our pre-print:

Holt, J. M., Saunders, C. T., Rowell, W. J., Kronenberg, Z., Wenger, A. M., & Eberle, M. (2023). HiPhase: Jointly phasing small and structural variants from HiFi sequencing. bioRxiv, 2023-05.

Need help?

If you notice any missing features, bugs, or need assistance with analyzing the output of HiPhase, please don't hesitate to reach out by email or open a GitHub issue.

Support information

HiPhase is a pre-release software intended for research use only and not for use in diagnostic procedures. While efforts have been made to ensure that HiPhase lives up to the quality that PacBio strives for, we make no warranty regarding this software.

As HiPhase is not covered by any service level agreement or the like, please do not contact a PacBio Field Applications Scientists or PacBio Customer Service for assistance with any HiPhase release. Please report all issues through GitHub instead. We make no warranty that any such issue will be addressed, to any extent or within any time frame.

DISCLAIMER

THIS WEBSITE AND CONTENT AND ALL SITE-RELATED SERVICES, INCLUDING ANY DATA, ARE PROVIDED "AS IS," WITH ALL FAULTS, WITH NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY, NON-INFRINGEMENT OR FITNESS FOR A PARTICULAR PURPOSE. YOU ASSUME TOTAL RESPONSIBILITY AND RISK FOR YOUR USE OF THIS SITE, ALL SITE-RELATED SERVICES, AND ANY THIRD PARTY WEBSITES OR APPLICATIONS. NO ORAL OR WRITTEN INFORMATION OR ADVICE SHALL CREATE A WARRANTY OF ANY KIND. ANY REFERENCES TO SPECIFIC PRODUCTS OR SERVICES ON THE WEBSITES DO NOT CONSTITUTE OR IMPLY A RECOMMENDATION OR ENDORSEMENT BY PACIFIC BIOSCIENCES.