From b38c2b9371428b47c943ca44b4a69971dd81357f Mon Sep 17 00:00:00 2001 From: nfrerebeau Date: Tue, 17 Sep 2024 23:54:04 +0200 Subject: [PATCH] Add badges and citation in README --- README.Rmd | 22 +++++++++++++++++----- README.md | 36 +++++++++++++++++++++++++++++++----- 2 files changed, 48 insertions(+), 10 deletions(-) diff --git a/README.Rmd b/README.Rmd index 1c01e90..f6598c8 100644 --- a/README.Rmd +++ b/README.Rmd @@ -17,16 +17,28 @@ library(BayLum) # BayLum + +[![R-CMD-check](https://github.com/crp2a/BayLum/workflows/GitHub Actions CI/badge.svg)](https://github.com/crp2a/BayLum/actions) +[![codecov](https://codecov.io/gh/crp2a/BayLum/graph/badge.svg?token=cOdZr6imKX)](https://app.codecov.io/gh/crp2a/BayLum) + +[![r-universe](https://crp2a.r-universe.dev/badges/BayLum)](https://crp2a.r-universe.dev/BayLum) +[![CRAN Version](https://www.r-pkg.org/badges/version/BayLum)](https://cran.r-project.org/package=BayLum) +[![CRAN checks](https://badges.cranchecks.info/worst/BayLum.svg)](https://cran.r-project.org/web/checks/check_results_BayLum.html) +[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/grand-total/BayLum)](https://cran.r-project.org/package=BayLum) + [![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) + +[![DOI Zenodo](https://zenodo.org/badge/DOI/10.5281/zenodo.4311266.svg)](https://doi.org/10.5281/zenodo.4311266) [![CRAN DOI](https://img.shields.io/badge/doi-10.32614/CRAN.package.BayLum-blue.svg)](https://doi.org/10.32614/CRAN.package.BayLum) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4311266.svg)](https://doi.org/10.5281/zenodo.4311266) -[![CRAN](https://www.r-pkg.org/badges/version/BayLum)](https://CRAN.R-project.org/package=BayLum) -[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/BayLum)](https://www.r-pkg.org/pkg/BayLum) -[![R-CMD-check](https://github.com/crp2a/BayLum/workflows/GitHub Actions CI/badge.svg)](https://github.com/crp2a/BayLum/actions) -[![codecov](https://app.codecov.io/gh/crp2a/BayLum/branch/master/graph/badge.svg?token=cOdZr6imKX)](https://app.codecov.io/gh/crp2a/BayLum) + An R package for chronological **Bay**esian models integrated for Optically Stimulated (OSL) **Lum**inescence Dating +```{r citation, echo=FALSE, comment=''} +cite <- utils::citation("BayLum") +print(cite, bibtex = FALSE) +``` + ## Installation To install the latest development builds directly from GitHub, run diff --git a/README.md b/README.md index 975ddb1..1f6c165 100644 --- a/README.md +++ b/README.md @@ -7,20 +7,46 @@ # BayLum + + +[![R-CMD-check](https://github.com/crp2a/BayLum/workflows/GitHub%20Actions%20CI/badge.svg)](https://github.com/crp2a/BayLum/actions) +[![codecov](https://codecov.io/gh/crp2a/BayLum/graph/badge.svg?token=cOdZr6imKX)](https://app.codecov.io/gh/crp2a/BayLum) + +[![r-universe](https://crp2a.r-universe.dev/badges/BayLum)](https://crp2a.r-universe.dev/BayLum) +[![CRAN +Version](https://www.r-pkg.org/badges/version/BayLum)](https://cran.r-project.org/package=BayLum) +[![CRAN +checks](https://badges.cranchecks.info/worst/BayLum.svg)](https://cran.r-project.org/web/checks/check_results_BayLum.html) +[![CRAN +Downloads](https://cranlogs.r-pkg.org/badges/grand-total/BayLum)](https://cran.r-project.org/package=BayLum) + [![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) + +[![DOI +Zenodo](https://zenodo.org/badge/DOI/10.5281/zenodo.4311266.svg)](https://doi.org/10.5281/zenodo.4311266) [![CRAN DOI](https://img.shields.io/badge/doi-10.32614/CRAN.package.BayLum-blue.svg)](https://doi.org/10.32614/CRAN.package.BayLum) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4311266.svg)](https://doi.org/10.5281/zenodo.4311266) -[![CRAN](https://www.r-pkg.org/badges/version/BayLum)](https://CRAN.R-project.org/package=BayLum) -[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/BayLum)](https://www.r-pkg.org/pkg/BayLum) -[![R-CMD-check](https://github.com/crp2a/BayLum/workflows/GitHub%20Actions%20CI/badge.svg)](https://github.com/crp2a/BayLum/actions) -[![codecov](https://app.codecov.io/gh/crp2a/BayLum/branch/master/graph/badge.svg?token=cOdZr6imKX)](https://app.codecov.io/gh/crp2a/BayLum) + An R package for chronological **Bay**esian models integrated for Optically Stimulated (OSL) **Lum**inescence Dating + To cite the R package 'BayLum' please cite the R package itself and the + following article: + + Christophe C, Philippe A, Kreutzer S, Guérin G, Baumgarten F, + Frerebeau N (2024). _BayLum: Chronological Bayesian Models + Integrating Optically Stimulated Luminescence and Radiocarbon Age + Dating_. R package version 0.3.2, + . + + Philippe A, Guerin G, Kreutzer S (2019). "BayLum - An R package for + Bayesian analysis of OSL ages: An introduction." _Quaternary + Geochronology_, *49*, 16-24. doi:10.1016/j.quageo.2018.05.009 + . + ## Installation To install the latest development builds directly from GitHub, run