-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README #76
Update README #76
Conversation
Update the README of the bmm package to reflect the new structure of the package and refer to the vignettes for in-depth explanations for fitting the different models.
I have not yet found a way to automatically link the vignettes. Given that you might have had a look into this for the pkgdown website. I thought it might be easier for you to implement that. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #76 +/- ##
========================================
Coverage 63.29% 63.29%
========================================
Files 15 15
Lines 899 899
========================================
Hits 569 569
Misses 330 330 ☔ View full report in Codecov by Sentry. |
- fix a few typos - remove @ref to figures, as these don't work in github_document format - fix rendering of nested list on lines 95-102 - add links to vignettes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great. Some things weren't rendering properly, so I made a few minor tweaks, see last commit for details
Update the README of the bmm package to reflect the new structure of the package and refer to the vignettes for in-depth explanations for fitting the different models.
Summary
Tests
[x] Confirm that all tests passed
[x] Confirm that devtools::check() produces no errors
Release notes