Skip to content

Commit 1d5ad8a

Browse files
jimb3claude
andcommitted
Note GEN files are legacy; BGEN support in progress
Add a note at the top of the GEN files vignette that GEN files have largely been replaced by BGEN files and that BGEN support is in progress. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent d64a488 commit 1d5ad8a

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: BinaryDosage
22
Title: Creates, Merges, and Reads Binary Dosage Files
3-
Version: 1.0.0.9027
3+
Version: 1.0.0.9028
44
Authors@R:
55
c(person(given = "John",
66
family = "Morrison",

vignettes/usinggenfiles.Rmd

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,11 @@ knitr::opts_chunk$set(
1616
)
1717
```
1818

19-
This vignette documents the functions in the BinaryDosage package that convert GEN files to binary dosage files.
19+
**Note:** GEN files are rarely used today. They have largely been replaced by
20+
BGEN files, a binary format that is more compact and faster to read. Support
21+
for BGEN files in the BinaryDosage package is currently in progress.
22+
23+
This vignette documents the functions in the BinaryDosage package that convert GEN files to binary dosage files.
2024

2125
**Note:** The examples below use functions to access information in binary dosage files. Information about these functions can be found in the vignette [Using Binary Dosage Files](usingbdfiles.html). Data returned by the function <span style="font-family:Courier">getbdinfo</span> contains information about a binary dosage file. Information on the data return by <span style="font-family:Courier">getbdinfo</span> can be found in the vignette [Genetic File Information](geneticfileinfo.html).
2226

0 commit comments

Comments
 (0)