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 72: Split why it works vignette into intro and analytic solutions vignette #106

Conversation

SamuelBrand1
Copy link
Collaborator

@SamuelBrand1 SamuelBrand1 commented Sep 24, 2024

Description

This PR closes #72 and this PR closes #91 .

In this PR I have done two things:

  1. Split the "Why it works" vignette away from the analytic solutions, which are now in their own vignette.
  2. Beefed up the comparisons to the "Why it works" approach and both the generative model described in "Getting started" and the work of @parksw3 . I've acknowledged @parksw3 for writing out the direct link, which I've add a bit more explanation to.

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 Sep 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.76%. Comparing base (2e7765f) to head (2ae9be0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #106   +/-   ##
=======================================
  Coverage   99.76%   99.76%           
=======================================
  Files          10       10           
  Lines         427      427           
=======================================
  Hits          426      426           
  Misses          1        1           
Flag Coverage Δ
99.76% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@seabbs seabbs enabled auto-merge (squash) September 24, 2024 13:01
Copy link
Contributor

@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.

This is great and thanks for redefining to d d- pwindow. In another issue we should move to having one sentence a line as it's much easier to read when reviewing.

vignettes/analytic-solutions.Rmd Show resolved Hide resolved
@seabbs seabbs merged commit d293504 into main Sep 24, 2024
10 checks passed
@seabbs seabbs deleted the 72-split-why-it-works-vignette-into-intro-and-analytic-solutions-vignette branch September 24, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants