Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Make package description in metadata and README more generic#140

Open
matt-graham wants to merge 1 commit into
mainUCL/rmcmc:mainfrom
mmg/update-descriptionUCL/rmcmc:mmg/update-descriptionCopy head branch name to clipboard
Open

Make package description in metadata and README more generic#140
matt-graham wants to merge 1 commit into
mainUCL/rmcmc:mainfrom
mmg/update-descriptionUCL/rmcmc:mmg/update-descriptionCopy head branch name to clipboard

Conversation

@matt-graham

Copy link
Copy Markdown
Collaborator

Resolves #131

Broadens scope of package description in DESCRIPTION file and also shortens this to cover only key high level details.
The more detailed package description in README is also broadened to concentrate less on Barker proposal specifically and highlight modular design of package.

@matt-graham
matt-graham requested a review from sam0287 July 23, 2026 13:47
@matt-graham matt-graham added the documentation Improvements or additions to documentation label Jul 23, 2026
@codecov

codecov Bot commented Jul 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (eb90251) to head (ef080d5).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #140   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           11        11           
  Lines          762       762           
=========================================
  Hits           762       762           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread DESCRIPTION
available on GitHub <https://github.com/roualdes/bridgestan>, is installed,
then 'BridgeStan' can be used to specify the target distribution to sample
from.
Description: Functions for simulating Markov chains using random-walk, Langevin,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggest not mentioning specific algorithms here, broaden instead to simulating and comparing Markov chain algorithms, mention that we have these ones pre-coded but users can add others bla bla bla

Comment thread README.md
proposal to compute *Markov chain Monte Carlo* (MCMC) estimates of
expectations with respect to a target distribution on a real-valued
vector space. The Barker proposal, described in [Livingstone and Zanella
`rmcmc` is an R package for simulating Markov chains using random-walk,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same comment here, better not to focus so much on any specific algorithm

Comment thread README.Rmd
`rmcmc` is an R package for simulating Markov chains using the Barker proposal
to compute _Markov chain Monte Carlo_ (MCMC) estimates of expectations with
respect to a target distribution on a real-valued vector space.
`rmcmc` is an R package for simulating Markov chains using random-walk, Langevin,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same comment as above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README to reflect broader scope of package

2 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.