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 #382: Reorganise function locations #389

Merged
merged 12 commits into from
Oct 16, 2024
Merged

Issue #382: Reorganise function locations #389

merged 12 commits into from
Oct 16, 2024

Conversation

athowes
Copy link
Collaborator

@athowes athowes commented Oct 15, 2024

Description

This PR will close #382. Creates:

  • fit.R
  • stancode.R
  • validate.R

Removes:

  • defaults.R
  • generics.R

I think this is much clearer as a structure.

Follow up issues to create or add comments to existing issues:

  • epidist_stancode.default can just pass back NULL or whatever it is does nothing. Doesn't need to abort.
  • epidist_validate.default contains the catcher for data without a model class. Could make this error message more informative then?
  • Do we want to export validate functions? Stan code functions? Users are not going to need to create these functions but they will need to create instances of the methods for their model

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 marked this pull request as ready for review October 15, 2024 09:37
Copy link

codecov bot commented Oct 15, 2024

Codecov Report

Attention: Patch coverage is 85.71429% with 3 lines in your changes missing coverage. Please review.

Project coverage is 90.06%. Comparing base (d02c7c7) to head (3627b13).
Report is 31 commits behind head on main.

Files with missing lines Patch % Lines
R/stancode.R 25.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #389      +/-   ##
==========================================
+ Coverage   88.55%   90.06%   +1.51%     
==========================================
  Files          11       15       +4     
  Lines         402      443      +41     
==========================================
+ Hits          356      399      +43     
+ Misses         46       44       -2     

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

@athowes athowes requested a review from seabbs October 15, 2024 14:30
seabbs
seabbs previously approved these changes Oct 15, 2024
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

@seabbs
Copy link
Contributor

seabbs commented Oct 15, 2024

Agree with the points for further issues.

Do we want to export validate functions? Stan code functions? Users are not going to need to create these functions but they will need to create instances of the methods for their model

IF we move to the validation model that scoring utils now uses we may be able to side step this discussion (validation .[ methods)

@seabbs
Copy link
Contributor

seabbs commented Oct 15, 2024

Agree with the points for further issues.

Do we want to export validate functions? Stan code functions? Users are not going to need to create these functions but they will need to create instances of the methods for their model

IF we move to the validation model that scoring utils now uses we may be able to side step this discussion (validating.[ methods). As it stands I think we need to export it

@athowes athowes merged commit 0eacf11 into main Oct 16, 2024
7 checks passed
@athowes athowes deleted the reorg-locations branch October 16, 2024 08:46
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.

Reorganise function locations
2 participants