# RSeqAn
SeqAn Headers for R
[](https://travis-ci.org/compbiocore/RSeqAn) [](https://codecov.io/gh/compbiocore/RSeqAn) [](https://opensource.org/licenses/BSD-3-Clause)
## Overview
This package provides R with access to [SeqAn v2.4](http://www.seqan.de/) header files. SeqAn is an open source C++ library of efficient algorithms and data structures for the analysis of sequences with the focus on biological data.
## Usage
RSeqAn can be used via the `LinkingTo:` field in the `DESCRIPTION` field of an R package. Note that the compiler will need to compile as C++14. This can be done in R as `Sys.setenv("PKG_CXXFLAGS"="-std=c++14")`.
## Installation
We recommend installing the release version [through Bioconductor](https://bioconductor.org/packages/release/bioc/html/RSeqAn.html). Instructions are provided on their page.
If you have `devtools`, then the development version can be installed from here by running:
```r
devtools::install_github("compbiocore/RSeqAn")
```
This version contains `Rcpp::as` and `Rcpp::wrap` functions for `CharString`.
## Author
August Guang
## Release history
See [`NEWS`](/inst/NEWS) for release history.
## Citation
To cite this package from within R, enter `citation("RSeqAn")`. Citation is also provided below:
Guang A (2018). *RSeqAn: R SeqAn.* R package version 1.2.0.
Please do not forget to cite SeqAn if you use this package in your acedemic work, even if only in auxiliary tools or pipelines: https://doi.org/10.1016/j.jbiotec.2017.07.017