Skip to content

Commit

Permalink
Added badges to the README, updated usage instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
LTLA committed Aug 27, 2024
1 parent 43d6d9b commit 4c20011
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Read R objects via tatami

![Unit tests](https://github.com/tatami-inc/tatami_r/actions/workflows/run-tests.yaml/badge.svg)
![Documentation](https://github.com/tatami-inc/tatami_r/actions/workflows/doxygenate.yaml/badge.svg)

## Overview

**tatami_r** is an header-only library for reading abstract R matrices in [**tatami**](https://github.com/tatami-inc/tatami).
Expand Down Expand Up @@ -72,13 +75,14 @@ Check out the [comments about safe parallelization](docs/parallel.md) for more g
This is most easily done by modifying the package `DESCRIPTION` with:
```
LinkingTo: beachmat, Rcpp
LinkingTo: beachmat, assorthead, Rcpp
```
which will automatically use the vendored copies of **tatami_r** (and **tatami**) inside the [**beachmat**](http://bioconductor.org/packages/beachmat) package.
which will automatically use the vendored copies of **tatami_r** (and **tatami**) inside the [**assorthead**](http://bioconductor.org/packages/assorthead) package,
along with some of pre-configured macro definitions for safe parallelization in [**beachmat**](https://bioconductor.org/packages/beachmat)'s `Rtatami.h` header.
Note that C++17 is required.
If **beachmat** cannot be used, then the R package developer will need to copy the **tatami_r** and **tatami** `include/` directories into the package's `inst/include`,
If **assorthead** or **beachmat** cannot be used, the R package developer will need to copy the **tatami_r** and **tatami** `include/` directories into the package's `inst/include`,
and then add a `Makevars` file like:
```
Expand Down

0 comments on commit 4c20011

Please sign in to comment.