Make package description in metadata and README more generic - #140
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
| 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, |
There was a problem hiding this comment.
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
| 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, |
There was a problem hiding this comment.
Same comment here, better not to focus so much on any specific algorithm
| `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, |
|
@sam0287 I've updated the descriptions in README and metadata to avoid focussing on specific algorithms as per your review comments and emphasise the ability for users to add their own algorithms. If you're happy with these changes either comment here or you can use the 'Approve' button from review interface (go to files tab). |
2 participants
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.