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 #64: Add vignette explaining models #514

Merged
merged 12 commits into from
Feb 18, 2025
Merged

Issue #64: Add vignette explaining models #514

merged 12 commits into from
Feb 18, 2025

Conversation

parksw3
Copy link
Collaborator

@parksw3 parksw3 commented Jan 28, 2025

Description

This PR closes #64.

Adds a model write up vignette for the naive and latent models.

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.

@athowes athowes changed the title model vignette in a new branch Issue #64: Add vignette explaining models Jan 29, 2025
vignettes/model.Rmd Outdated Show resolved Hide resolved
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 really nice @parksw3 and personally I am pretty happy with it as is if you are? The only thing missing from this for me is to update the news file and the pkgdown yaml (so that this is listed on the package website). In a follow issue I guess we need to link to this new vignette from elsewhere in the package?

@parksw3
Copy link
Collaborator Author

parksw3 commented Feb 11, 2025

I think there's just a bit more I want to edit/add. I'll do that towards the end of this week alongside updating the news file and the pkgdown yaml.

@parksw3
Copy link
Collaborator Author

parksw3 commented Feb 18, 2025

Sorry, it took me longer than I expected to get to this. I tweaked the text very tiny bit and added the new file to package yaml. Am happy with it as is.

Copy link

codecov bot commented Feb 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.38%. Comparing base (3a40384) to head (7aa2b75).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #514   +/-   ##
=======================================
  Coverage   94.38%   94.38%           
=======================================
  Files          17       17           
  Lines         837      837           
=======================================
  Hits          790      790           
  Misses         47       47           

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

seabbs
seabbs previously approved these changes Feb 18, 2025
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.

Nice looks good to me. I fixed the linting issues, added some fluff text, checked some grammar, and removed the commented out code.

@seabbs seabbs merged commit f5eead1 into main Feb 18, 2025
9 checks passed
@seabbs seabbs deleted the model-vignette-new branch February 18, 2025 12:17
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 explaining model
2 participants