README.Rmd

---
output: github_document
---

```{r}
#| echo: false
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/"
)
```

# cpp11bigwig

<!-- badges: start -->
[![R-CMD-check](https://github.com/rnabioco/cpp11bigwig/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rnabioco/cpp11bigwig/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/rnabioco/cpp11bigwig/graph/badge.svg)](https://app.codecov.io/gh/rnabioco/cpp11bigwig)
<!-- badges: end -->

cpp11bigwig provides read-only access to bigWig and bigBed files using libBigWig <https://github.com/dpryan79/libBigWig>.

## Installation

::: .pkgdown-release
```{r, eval = FALSE}
# Install released version from CRAN
install.packages("cpp11bigwig")
```
:::

::: .pkgdown-devel
```{r}
#| eval: false
# Install development version from GitHub
# install.packages("pak")
pak::pak("rnabioco/cpp11bigwig")
```
:::


```{r}
library(cpp11bigwig)

bw <- system.file('extdata', 'test.bw', package = 'cpp11bigwig')
read_bigwig(bw)

bb <- system.file('extdata', 'test.bb', package = 'cpp11bigwig')
read_bigbed(bb)
```