@@ -33,18 +33,19 @@ to develop new `R` packages that can leverage `RcppTskit`.
3333
3434<!-- Row 1 -->
3535General: [ ![ Lifecycle: experimental] ( https://img.shields.io/badge/lifecycle-experimental-orange.svg )] ( https://lifecycle.r-lib.org/articles/stages.html#experimental ) <!-- Col-1-End -->
36- [ ![ Development] ( https://img.shields.io/badge/development-active-blue.svg )] ( https://img.shields.io/badge/development-active-blue.svg ) <!-- Col-2-End -->
36+ [ ![ Development] ( https://img.shields.io/badge/development-active-blue.svg )] ( https://github.com/HighlanderLab/RcppTskit?tab=readme-ov-file#development ) <!-- Col-2-End -->
3737[ ![ Licence] ( https://img.shields.io/badge/licence-MIT-blue.svg )] ( https://opensource.org/licenses/MIT ) <!-- Col-3-End -->
3838
3939<!-- Row 2 -->
4040Release: [ ![ CRAN version] ( https://www.r-pkg.org/badges/version/RcppTskit )] ( https://CRAN.R-project.org/package=RcppTskit ) <!-- Col-1-End -->
4141[ ![ Downloads - total] ( https://cranlogs.r-pkg.org/badges/grand-total/RcppTskit )] ( https://cranlogs.r-pkg.org/badges/grand-total/RcppTskit ) <!-- Col-2-End -->
42- ![ GitHub version (main)] ( https://img.shields.io/github/r-package/v/HighlanderLab/RcppTskit/main?filename=RcppTskit%2FDESCRIPTION&label=Github ) <!-- Col-3-End -->
42+ [ ![ GitHub version (main)] ( https://img.shields.io/github/r-package/v/HighlanderLab/RcppTskit/main?filename=RcppTskit%2FDESCRIPTION&label=Github )] ( https://github.com/HighlanderLab/RcppTskit ) <!-- Col-3-End -->
4343
4444<!-- Row 3 -->
45- R CMD checks: [ ![ CRAN] ( https://cranchecks.info/badges/summary/RcppTskit?label=CRAN )] ( https://cran.r-project.org/web/checks/check_results_RcppTskit.html ) <!-- Col-1-End -->
46- [ ![ R universe] ( https://highlanderlab.r-universe.dev/RcppTskit/badges/checks?label=R-universe )] ( https://highlanderlab.r-universe.dev/RcppTskit ) <!-- Col-2-End -->
47- [ ![ GitHub] ( https://img.shields.io/github/actions/workflow/status/HighlanderLab/RcppTskit/R-CMD-check.yaml?label=GitHub )] ( https://github.com/HighlanderLab/RcppTskit/actions/workflows/R-CMD-check.yaml ) <!-- Col-3-End -->
45+ R CMD checks: [ ![ CRAN summary] ( https://badges.cranchecks.info/summary/RcppTskit.svg )] ( https://cran.r-project.org/web/checks/check_results_RcppTskit.html ) <!-- Col-1-End -->
46+ [ ![ CRAN worst] ( https://badges.cranchecks.info/worst/RcppTskit.svg )] ( https://cran.r-project.org/web/checks/check_results_RcppTskit.html ) <!-- Col-2-End -->
47+ [ ![ R universe] ( https://highlanderlab.r-universe.dev/RcppTskit/badges/checks?label=R-universe )] ( https://highlanderlab.r-universe.dev/RcppTskit ) <!-- Col-3-End -->
48+ [ ![ GitHub] ( https://img.shields.io/github/actions/workflow/status/HighlanderLab/RcppTskit/R-CMD-check.yaml?label=GitHub )] ( https://github.com/HighlanderLab/RcppTskit/actions/workflows/R-CMD-check.yaml ) <!-- Col-4-End -->
4849
4950<!-- Row 4 -->
5051Code quality: [ ![ Codecov test coverage] ( https://codecov.io/gh/HighlanderLab/RcppTskit/graph/badge.svg )] ( https://app.codecov.io/gh/HighlanderLab/RcppTskit ) <!-- Col-1-End -->
@@ -73,19 +74,25 @@ To install the published release from
7374[ CRAN] ( https://cran.r-project.org/package=RcppTskit ) use:
7475
7576```
77+ # Install
7678install.packages("RcppTskit")
79+
80+ # Read the introduction to RcppTskit
7781vignette("RcppTskit_intro")
7882```
7983
8084To install the latest development version (possibly unstable!) from
8185[ R universe] ( https://r-universe.dev ) use:
8286
8387```
88+ # Install
8489r_universe_and_cran <- c(
8590 "https://highlanderlab.r-universe.dev",
8691 "https://cloud.r-project.org"
8792 )
8893install.packages("RcppTskit", repos = r_universe_and_cran)
94+
95+ # Read the introduction to RcppTskit
8996vignette("RcppTskit_intro")
9097```
9198
@@ -102,19 +109,18 @@ https://mac.r-project.org/tools for macOS tools.
102109```
103110# install.packages("remotes") # If you don't have it already
104111
105- # Release
106- # TODO: Tag a release #15
107- # https://github.com/HighlanderLab/RcppTskit/issues/15
108- # remotes::install_github("HighlanderLab/RcppTskit/RcppTskit")
109-
110- # Main branch
112+ # Install the main branch
111113remotes::install_github("HighlanderLab/RcppTskit/RcppTskit@main",
112114 build_vignettes=TRUE)
113115
114- # Development branch
116+ # Install the development branch
115117remotes::install_github("HighlanderLab/RcppTskit/RcppTskit@devel",
116118 build_vignettes=TRUE)
117119
120+ # Install a specific release (say, v0.2.0)
121+ remotes::install_github("HighlanderLab/RcppTskit/RcppTskit@v0.2.0")
122+
123+ # Read the introduction to RcppTskit
118124vignette("RcppTskit_intro")
119125```
120126
0 commit comments