Skip to content

Add Bayesian Analysis paper reference and complete rankings example to README#62

Merged
osorensen merged 5 commits intomainfrom
copilot/update-readme-with-bayesian-paper
Jan 22, 2026
Merged

Add Bayesian Analysis paper reference and complete rankings example to README#62
osorensen merged 5 commits intomainfrom
copilot/update-readme-with-bayesian-paper

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 22, 2026

Adds reference to the Bayesian Analysis paper (Sørensen et al. 2025) and includes a working example demonstrating the package's core functionality with posterior visualizations.

Changes

  • inst/REFERENCES.bib: Added BibTeX entry for the Bayesian Analysis paper (DOI: 10.1214/25-BA1564)
  • README.Rmd:
    • Configured bibliography in YAML header
    • Cited paper in package description
    • Added complete example using complete_rankings dataset with model fitting and posterior plots for α (dispersion) and ρ (ranking positions)
    • Added References section for automatic citation formatting
  • README.md: Rendered output with evaluated code chunks and two posterior distribution plots
  • .gitignore: Excluded README.html intermediate file

Example Output

mod <- compute_sequentially(
  complete_rankings,
  hyperparameters = set_hyperparameters(n_items = 5),
  smc_options = set_smc_options(n_particles = 100, n_particle_filters = 1)
)

summary(mod)  # Model summary
plot(mod, parameter = "alpha")  # Posterior distribution

The example demonstrates sequential inference with 100 particles over 100 timepoints, including model summary statistics and posterior visualizations for key parameters.

Original prompt

This section details on the original issue you should resolve

<issue_title>Update README.Rmd</issue_title>
<issue_description>Update the readme file with a reference to the Bayesian Analysis paper

@Article{10.1214/25-BA1564,
author = {{\O}ystein S{\o}rensen and Anja Stein and Waldir Leoncio Netto and David S. Leslie},
title = {{Sequential Rank and Preference Learning with the Bayesian Mallows Model}},
journal = {Bayesian Analysis},
publisher = {International Society for Bayesian Analysis},
pages = {1 -- 26},
keywords = {Mallows mixtures, partial rankings, particle filter, preference learning, SMC2},
year = {2025},
doi = {10.1214/25-BA1564},
URL = {https://doi.org/10.1214/25-BA1564}
}

Also include a small example with the complete rankings data showing trace plots and posterior summaries.</issue_description>

Comments on the Issue (you are @copilot in this section)

@osorensen Put the reference in inst/REFERENCES.bib and use BibTeX for referencing. This because I will later insert references with BibTeX also in the documentation and in vignettes.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…mple

Co-authored-by: osorensen <21175639+osorensen@users.noreply.github.com>
@osorensen osorensen marked this pull request as ready for review January 22, 2026 09:45
Copy link
Copy Markdown
Owner

@osorensen osorensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Don't include the plot of tau in readme, since we don't have more than one cluster.
  • Use summary and not print for showing the model output.

Co-authored-by: osorensen <21175639+osorensen@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README with reference to Bayesian Analysis paper Add Bayesian Analysis paper reference and complete rankings example to README Jan 22, 2026
Copilot AI requested a review from osorensen January 22, 2026 09:50
Co-authored-by: osorensen <21175639+osorensen@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jan 22, 2026

  • Don't include the plot of tau in readme, since we don't have more than one cluster.
  • Use summary and not print for showing the model output.

Done in e4a864f. Removed the tau plot section and changed print(mod) to summary(mod) in the example.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • cran.r-project.org
    • Triggering command: /usr/lib/R/bin/exec/R /usr/lib/R/bin/exec/R -e install.packages(c(&#34;knitr&#34;,~&#43;~&#34;rmarkdown&#34;),~&#43;~repos=&#34;REDACTED&#34;,~&#43;~quiet=TRUE) (dns block)
  • esm.ubuntu.com
    • Triggering command: /usr/lib/apt/methods/https /usr/lib/apt/methods/https (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

@osorensen osorensen merged commit 1e39054 into main Jan 22, 2026
5 checks passed
@osorensen osorensen deleted the copilot/update-readme-with-bayesian-paper branch January 22, 2026 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README.Rmd

2 participants