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

Add interventions vignette (and remove intvn_reduce_mean argument) #106

Merged
merged 6 commits into from
Nov 10, 2023

Conversation

sbfnk
Copy link
Contributor

@sbfnk sbfnk commented Nov 8, 2023

  • Please check if the PR fulfills these requirements
  • I have read the CONTRIBUTING guidelines
  • A new item has been added to NEWS.md
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Adds a vignette on how to model interventions.

  • What is the current behavior? (You can also link to an open issue here)

n/a

  • What is the new behavior (if this is a feature change)?

n/a

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Yes with respect to the previous development version, as it removes the intvn_reduce_mean argument.

  • Other information:

Closes #103

@sbfnk sbfnk requested a review from jamesmbaazam November 8, 2023 15:35
@sbfnk sbfnk changed the title remove intvn_reduce_mean argument Add interventions vignette (and remove intvn_reduce_mean argument) Nov 8, 2023
Copy link
Member

@jamesmbaazam jamesmbaazam left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, @sbfnk.

The deletions in the functions all LGTM.

The vignette is really insightful and highlights how to use the models with extra customizations through external functions suited to the user's use case.

I've added a few suggestions here and there.

vignettes/interventions.Rmd Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Nov 9, 2023

Codecov Report

Merging #106 (673b151) into main (5a59132) will decrease coverage by 0.09%.
Report is 21 commits behind head on main.
The diff coverage is n/a.

❗ Current head 673b151 differs from pull request most recent head e614d98. Consider uploading reports for the commit e614d98 to get more accurate results

@@            Coverage Diff             @@
##             main     #106      +/-   ##
==========================================
- Coverage   98.91%   98.82%   -0.09%     
==========================================
  Files           9        8       -1     
  Lines         459      424      -35     
==========================================
- Hits          454      419      -35     
  Misses          5        5              
Files Coverage Δ
R/simulate.r 98.83% <ø> (-0.16%) ⬇️

📣 Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!

@sbfnk sbfnk merged commit ee2b201 into main Nov 10, 2023
8 checks passed
@sbfnk sbfnk deleted the interventions-vignette branch November 10, 2023 09:14
@jamesmbaazam jamesmbaazam mentioned this pull request Nov 10, 2023
3 tasks
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.

Vignette: How to model interventions
3 participants