Skip to content

Commit 57d05ad

Browse files
authored
Merge pull request #78 from osorensen/copilot/update-readme-rmd
Add CRAN installation instructions and badge to README
2 parents b699c51 + 3628510 commit 57d05ad

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

README.Rmd

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,21 @@ knitr::opts_chunk$set(
1717
# BayesMallowsSMC2
1818

1919
<!-- badges: start -->
20+
[![CRAN status](https://www.r-pkg.org/badges/version/BayesMallowsSMC2)](https://CRAN.R-project.org/package=BayesMallowsSMC2)
2021
[![R-CMD-check](https://github.com/osorensen/BayesMallowsSMC2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/osorensen/BayesMallowsSMC2/actions/workflows/R-CMD-check.yaml)
2122
<!-- badges: end -->
2223

2324
BayesMallowsSMC2 provides functions for performing sequential inference in the Bayesian Mallows model using the SMC2 algorithm [@10.1214/25-BA1564].
2425

2526
## Installation
2627

27-
You can install the development version of BayesMallowsSMC2 from [GitHub](https://github.com/) with:
28+
You can install the released version of BayesMallowsSMC2 from [CRAN](https://CRAN.R-project.org) with:
29+
30+
``` r
31+
install.packages("BayesMallowsSMC2")
32+
```
33+
34+
Or install the development version of BayesMallowsSMC2 from [GitHub](https://github.com/) with:
2835

2936
``` r
3037
# install.packages("devtools")

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55

66
<!-- badges: start -->
77

8+
[![CRAN
9+
status](https://www.r-pkg.org/badges/version/BayesMallowsSMC2)](https://CRAN.R-project.org/package=BayesMallowsSMC2)
810
[![R-CMD-check](https://github.com/osorensen/BayesMallowsSMC2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/osorensen/BayesMallowsSMC2/actions/workflows/R-CMD-check.yaml)
911
<!-- badges: end -->
1012

@@ -14,7 +16,14 @@ in the Bayesian Mallows model using the SMC2 algorithm (Sørensen et al.
1416

1517
## Installation
1618

17-
You can install the development version of BayesMallowsSMC2 from
19+
You can install the released version of BayesMallowsSMC2 from
20+
[CRAN](https://CRAN.R-project.org) with:
21+
22+
``` r
23+
install.packages("BayesMallowsSMC2")
24+
```
25+
26+
Or install the development version of BayesMallowsSMC2 from
1827
[GitHub](https://github.com/) with:
1928

2029
``` r

0 commit comments

Comments
 (0)