Creates, Merges, and Reads Binary Dosage Files
Overview
Tools to create binary dosage files from either VCF or GEN files, merge binary dosage files, and read binary dosage files. Binary dosage files tend to have quicker read times than VCF and GEN formats. There is a small increase in size compared to compressed VCF and GEN files.
- Removed
CXX_STD = CXX11fromsrc/Makevars; the package now builds with the default C++17 standard. - Added Format 5 binary dosage files, a new format using per-SNP gzip compression and a companion RDS metadata file (
.bdinfo). vcftobd5()— convert a bgzipped VCF file to Format 5.getbd5info()— load and validate a Format 5 file pair.getbd5snp()— read a single SNP from a Format 5 file by index or ID.- Added
vcftobd()as the new recommended function for converting VCF files to binary dosage format (requires the vcfppR package). The previousvcftobd()has been renamed tovcftobdlegacy()and emits a deprecation message. - Added
updatebd()to convert any legacy binary dosage file (formats 1–4) to Format 5.
Show all changes in 2.0.0Hide the rest of the changes in 2.0.0
- Added
subsetbd()to create a new Format 5 file containing a subset of SNPs and/or subjects from any binary dosage file (formats 1–5). Filtering options: minimum MAF, SNP location vector, SNP location range, and subject ID vector. - Added
mergebd()to merge two or more Format 5 files into a single Format 5 file. Automatically performs a subject merge (unique subjects, common SNPs) or a SNP merge (unique SNPs, common subjects) depending on the input files. - Extended
getsnp()andbdapply()to support Format 5 files.
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-05
- NOTE12 OK, 1 NOTE2026-08-01
- OK7 OK2026-05-02
- NOTE5 OK, 1 NOTE2026-04-30
Documentation
- Help pages
- 26 (4 internal)
- Examples that run
- 100%16 run in a plain check
- Exported functions with examples
- 73%
- Documented parameters
- 99%
- Return-value docs
- 100%
- Help pages citing references
- 0%
- Binary Dosage Formats HTML
- Estimating Imputed R-squares HTML
- Genetic File Information HTML
- Legacy Binary Dosage Formats (Formats 1-4)
- Merging Files HTML
- Merging Format 5 Binary Dosage Files
- Reading SNPs from Format 5 Files
- Using Binary Dosage files HTML
- Using Format 5 Binary Dosage Files
- Using GEN Files
Show 1 moreHide 1 vignette
Downloads
Dependencies
Installing BinaryDosage adds 32 packages (12 with compiled code, 26 MB of source tarballs). Heaviest: ggplot2 6.0 MB, data.table 5.7 MB, Rcpp 1.8 MB.
Code & Tests
Datasets
People & History
Pick two releases to compare their code metrics.
- unarchivedReturned to CRAN2026-04-29
- 2.0.0Latest2026-04-29 · current release · diff ↗ ·
added 9 exports
closebd5con, getbd5snp, getbd5snp_buf, getbd5snp_con, mergebd, openbd5con, subsetbd, updatebd, vcftobdlegacy - RR 4.6.0 released · 2026-04-24
- archivedRemoved from CRAN2025-12-25issues were not addressed in time
- RR 4.5.0 released · 2025-04-11
- RR 4.4.0 released · 2024-04-24
- RR 4.3.0 released · 2023-04-21
- RR 4.2.0 released · 2022-04-22
- RR 4.1.0 released · 2021-05-18
- RR 4.0.0 released · 2020-04-24
- 1.0.02020-01-13
- RR 3.6.0 released · 2019-04-26
Package metadata
- First published
- 2020-01-13
- Total releases
- 2 / 6 yrs
- License
- GPL-3 OSI
- Download size
- 228 KB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("BinaryDosage")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-23, which the citation names so these numbers can be found later. More on citing and the projects behind them.