@@ -20,6 +20,8 @@ knitr::opts_chunk$set(
2020[ ![ Travis-CI Build Status] ( https://travis-ci.org/nhejazi/txshift.svg?branch=master )] ( https://travis-ci.org/nhejazi/txshift )
2121[ ![ AppVeyor Build Status] ( https://ci.appveyor.com/api/projects/status/github/nhejazi/txshift?branch=master&svg=true )] ( https://ci.appveyor.com/project/nhejazi/txshift )
2222[ ![ Coverage Status] ( https://img.shields.io/codecov/c/github/nhejazi/txshift/master.svg )] ( https://codecov.io/github/nhejazi/txshift?branch=master )
23+ [ ![ CRAN] ( http://www.r-pkg.org/badges/version/txshift )] ( http://www.r-pkg.org/pkg/txshift )
24+ [ ![ CRAN downloads] ( https://cranlogs.r-pkg.org/badges/txshift )] ( https://CRAN.R-project.org/package=txshift )
2325[ ![ Project Status: Active – The project has reached a stable, usable state and is being actively developed.] ( https://www.repostatus.org/badges/latest/active.svg )] ( https://www.repostatus.org/#active )
2426[ ![ MIT license] ( https://img.shields.io/badge/license-MIT-brightgreen.svg )] ( https://opensource.org/licenses/MIT )
2527
@@ -59,11 +61,25 @@ methodology described in @hejazi2020efficient.
5961
6062## Installation
6163
62- Install the most recent _ stable release_ from GitHub via
63- [ ` remotes ` ] ( https://CRAN.R-project.org/package=remotes ) :
64+ For standard use, we recommend installing the package from
65+ [ CRAN] ( https://CRAN.R-project.org/package=txshift ) via
66+
67+ ``` {r cran-installation, eval = FALSE}
68+ install.packages("txshift")
69+ ```
70+
71+ For the latest features, install the most recent _ stable version_ of ` txshift `
72+ from GitHub via [ ` remotes ` ] ( https://CRAN.R-project.org/package=remotes ) :
6473
6574``` {r gh-master-installation, eval = FALSE}
66- remotes::install_github("nhejazi/txshift", build_vignettes = FALSE)
75+ remotes::install_github("nhejazi/txshift@master")
76+ ```
77+
78+ To contribute, install the _ development version_ of ` txshift ` from GitHub via
79+ [ ` remotes ` ] ( https://CRAN.R-project.org/package=remotes ) :
80+
81+ ``` {r gh-devel-installation, eval = FALSE}
82+ remotes::install_github("nhejazi/txshift@devel")
6783```
6884
6985---
0 commit comments