Skip to content
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

Merged
merged 4 commits into from
Feb 9, 2024
Merged

Conversation

GidonFrischkorn
Copy link
Collaborator

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

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.
@GidonFrischkorn GidonFrischkorn linked an issue Feb 9, 2024 that may be closed by this pull request
@GidonFrischkorn
Copy link
Collaborator Author

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.

Copy link

codecov bot commented Feb 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (69d868c) 63.29% compared to head (c9dc37f) 63.29%.

❗ Current head c9dc37f differs from pull request most recent head 6efda61. Consider uploading reports for the commit 6efda61 to get more accurate results

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.
📢 Have feedback on the report? Share it here.

- 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
Copy link
Owner

@venpopov venpopov left a 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

@venpopov venpopov merged commit 14732ea into develop Feb 9, 2024
4 checks passed
@venpopov venpopov deleted the 63-rework-readme-and-landing-page-of-website branch February 9, 2024 09:28
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.

rework Readme and landing page of website
2 participants