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

Issue #548: Refactor the getting started vignette #549

Merged
merged 29 commits into from
Mar 7, 2025
Merged

Issue #548: Refactor the getting started vignette #549

merged 29 commits into from
Mar 7, 2025

Conversation

seabbs
Copy link
Contributor

@seabbs seabbs commented Mar 7, 2025

Description

This PR closes #548 #68 and #403 by refactoring the getting started vignette to:

  • Reduce the focus on simulating data
  • Make the entry to the package friendlier
  • Show a comparison of fitting a naive and a marginal model
  • Show how to get out the estimated parameters and plot them vs the truth

In developing this PR I have explored the predict workflow and corrected the following issues:

  • bounds were not set for mu parameters in custom families
  • I fixed a bug in predict_delay_parameters where it couldn't detect brms families when used directly.

I will open an issue for some thoughts on the current postprocess workflow as it feels like there are too many paths to take and some common tasks require to much work.

Checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title in the for Issue(s) issue-numbers: PR title
  • I have read the contribution guidelines.
  • I have tested my changes locally.
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required.
  • My code follows the established coding standards.
  • I have added a news item linked to this PR.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

Copy link

codecov bot commented Mar 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.66%. Comparing base (f08a6ce) to head (f110d7b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #549      +/-   ##
==========================================
+ Coverage   95.59%   95.66%   +0.07%     
==========================================
  Files          17       17              
  Lines         998     1015      +17     
==========================================
+ Hits          954      971      +17     
  Misses         44       44              

☔ View full report in Codecov by Sentry.
📢 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.

@seabbs seabbs linked an issue Mar 7, 2025 that may be closed by this pull request
Copy link
Contributor Author

@seabbs seabbs left a comment

Choose a reason for hiding this comment

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

LGTM from a read of the code (self-review). Waiting on the rendered site for final checks.

Copy link
Contributor Author

@seabbs seabbs left a comment

Choose a reason for hiding this comment

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

The html looks good so I think this is good to go.

@seabbs seabbs merged commit 39df3d3 into main Mar 7, 2025
9 of 11 checks passed
@seabbs seabbs deleted the issue548 branch March 7, 2025 19: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
1 participant