diff --git a/README.md b/README.md index 3b4b955..be92349 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,19 @@ Don't forget to set the C++14 compiler flags if you do this! ## Installation -We recommend installing the release version [through Bioconductor](https://bioconductor.org/packages/release/bioc/html/RSeqAn.html). Instructions are provided on their page. + * We recommend installing the release version [through Bioconductor](https://bioconductor.org/packages/release/bioc/html/RSeqAn.html), especially if you are running R on Windows. Instructions are provided on their page. -If you have `devtools`, then the development version can be installed from here by running: + * Version 1.3.1 can also be installed [through Bioconductor](http://bioconductor.org/packages/devel/bioc/html/RSeqAn.html) (for now, Bioconductor has a separate release cycle), downloaded as [a tagged release](https://github.com/compbiocore/RSeqAn/releases/tag/v1.3.1), or installed with `devtools` by running: ```r -devtools::install_github("compbiocore/RSeqAn") +devtools::install_github("compbiocore/RSeqAn", ref="v1.3.1") ``` -The development version contains `Rcpp::as` and `Rcpp::wrap` functions for `CharString`. +This version contains `Rcpp::as` and `Rcpp::wrap` functions for `CharString` and is the one submitted to the [Journal of Open Source Software](https://joss.theoj.org/). + + * The development version can be installed with `devtools` by running: +```r +devtools::install_github("compbiocore/RSeqAn", ref="devel") +``` +This version contains additional wrappers, though we cannot guarantee that they will work for you. ## Author diff --git a/paper/paper.md b/paper/paper.md index d18f886..a5f3930 100644 --- a/paper/paper.md +++ b/paper/paper.md @@ -3,7 +3,7 @@ title: 'RSeqAn: Headers and wrappers for the SeqAn library in R' author: - August Guang authors: -- affiliation: 1,2 +- affiliation: "1,2" name: August Guang orcid: 0000-0003-0872-7098 tags: @@ -16,8 +16,8 @@ affiliations: name: Center for Computation and Visualization, Brown University, Providence, Rhode Island, United States of America - index: 2 name: Center for Computational Biology of Human Disease, Brown University, Providence, Rhode Island, United States of America -- date: 5 February 2019 -- bibliography: paper.bib +date: 5 February 2019 +bibliography: paper.bib --- Summary