bump version to v0.4.5

Zilong-Li · Apr 8, 2024 · e4499fd · e4499fd
1 parent 26dee60
commit e4499fd
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 3 deletions.
diff --git a/.covrignore b/.covrignore
@@ -1,2 +1,3 @@
+src/vcfpp.h
 src/htslib-1.19.1/
 src/htslib-1.18/
diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,8 @@
+# vcfppR 0.4.5
+
+* add `vcfcomp` function
+* fix memory leaks and pass ASAN check
+
 # vcfppR 0.4.0
 
 * add `setid` option for vcftable

diff --git a/README.Rmd b/README.Rmd
@@ -23,7 +23,13 @@ knitr::opts_chunk$set(
 [![codecov](https://codecov.io/github/Zilong-Li/vcfppR/graph/badge.svg?token=QE1UFVRH98)](https://app.codecov.io/github/Zilong-Li/vcfppR)
 <!-- badges: end -->
 
-The vcfppR package implements various useful functions for rapidly manipulating VCF/BCF files in R using the C++ API of [vcfpp.h](https://github.com/Zilong-Li/vcfpp).
+The vcfppR package implements various powerful functions for fast genomics analyses with VCF/BCF files using the C++ API of [vcfpp.h](https://github.com/Zilong-Li/vcfpp).
+
+- Load/save content of VCF/BCF into R objects with highly customizable options
+- Visualize and chracterize variants
+- Compare two VCF/BCF files and report various statistics
+- Streaming read/write VCF/BCF files with fine control of everything
+- [Paper](https://doi.org/10.1093/bioinformatics/btae049) shows vcfppR is 20x faster than `vcfR`. Also, much faster than `cyvcf2`
 
 ## Installation
 

diff --git a/README.md b/README.md
@@ -13,10 +13,18 @@ status](https://www.r-pkg.org/badges/version/vcfppR)](https://CRAN.R-project.org
 [![codecov](https://codecov.io/github/Zilong-Li/vcfppR/graph/badge.svg?token=QE1UFVRH98)](https://app.codecov.io/github/Zilong-Li/vcfppR)
 <!-- badges: end -->
 
-The vcfppR package implements various useful functions for rapidly
-manipulating VCF/BCF files in R using the C++ API of
+The vcfppR package implements various powerful functions for fast
+genomics analyses with VCF/BCF files using the C++ API of
 [vcfpp.h](https://github.com/Zilong-Li/vcfpp).
 
+- Load/save content of VCF/BCF into R objects with highly customizable
+  options
+- Visualize and chracterize variants
+- Compare two VCF/BCF files and report various statistics
+- Streaming read/write VCF/BCF files with fine control of everything
+- [Paper](https://doi.org/10.1093/bioinformatics/btae049) shows vcfppR
+  is 20x faster than `vcfR`. Also, much faster than `cyvcf2`
+
 ## Installation
 
 ``` r

diff --git a/codecov.yaml b/codecov.yaml
@@ -1,4 +1,5 @@
 # sample regex patterns
 ignore:
+  - "src/vcfpp.h"      # this is coverged seperately in its own repo
   - "src/htslib-1.19.1"  # ignore folders and all its contents
   - "src/htslib-1.18"  # ignore folders and all its contents