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

Deprecate init_cumulative_fit() #572

Merged
merged 16 commits into from
Feb 26, 2024
Merged

Deprecate init_cumulative_fit() #572

merged 16 commits into from
Feb 26, 2024

Conversation

jamesmbaazam
Copy link
Contributor

Description

This PR closes #541.

This PR deprecates the init_cumulative_fit() function.

Initial submission checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have tested my changes locally (using devtools::test() and devtools::check()).
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required and rebuilt docs if yes (using devtools::document()).
  • I have followed the established coding standards (and checked using lintr::lint_package()).
  • I have added a news item linked to this PR.

After the initial Pull Request

  • I have reviewed Checks for this PR and addressed any issues as far as I am able.

NEWS.md Outdated Show resolved Hide resolved
@jamesmbaazam jamesmbaazam changed the title Point out deprecation of "cumulative" option Deprecation of "cumulative" option Feb 21, 2024
@jamesmbaazam jamesmbaazam changed the title Deprecation of "cumulative" option Deprecate init_cumulative_fit() Feb 21, 2024
Copy link
Contributor

@sbfnk sbfnk left a comment

Choose a reason for hiding this comment

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

  • Since stan_opts() is the function that users actually interact with, can we add a deprecation warning there? Something like
  lifecycle::deprecate_warn(
    "1.5.0", "stan_opts(init_fit)",
    details = "This argument will be removed in version 2.0.0."
  )

R/estimate_infections.R Outdated Show resolved Hide resolved
R/opts.R Outdated Show resolved Hide resolved
@jamesmbaazam
Copy link
Contributor Author

I didn't know about deprecation tests but was wondering about that yesterday. Good to know :).

@jamesmbaazam jamesmbaazam force-pushed the deprecate-init_cumulative_fit branch from a282ae3 to 3964e3e Compare February 22, 2024 16:50
NEWS.md Outdated Show resolved Hide resolved
@jamesmbaazam jamesmbaazam requested a review from sbfnk February 26, 2024 11:07
@sbfnk sbfnk enabled auto-merge (squash) February 26, 2024 11:20
@sbfnk sbfnk merged commit 9372afd into main Feb 26, 2024
9 checks passed
@sbfnk sbfnk deleted the deprecate-init_cumulative_fit branch February 26, 2024 12:34
jamesmbaazam added a commit that referenced this pull request Feb 26, 2024
* Point out deprecation of "cumulative" option

* Deprecate init_cumulative_fit function

* Add NEWS item

* Add PR number to NEWS item

* Linting: trailing white spaces

* Change versions

* Add deprecation warning for init_fit  argument

* Move deprecation statement to separate paragraph

* Add deprecation test

* Add reviewer

* Move deprecation warning to where the argument is called

* Revise deprecation message

* Don't use explicit namespacing

* Throw deprecation warning if init_fit argument isn't NULL

* Fix test
sbfnk pushed a commit that referenced this pull request May 3, 2024
* Point out deprecation of "cumulative" option

* Deprecate init_cumulative_fit function

* Add NEWS item

* Add PR number to NEWS item

* Linting: trailing white spaces

* Change versions

* Add deprecation warning for init_fit  argument

* Move deprecation statement to separate paragraph

* Add deprecation test

* Add reviewer

* Move deprecation warning to where the argument is called

* Revise deprecation message

* Don't use explicit namespacing

* Throw deprecation warning if init_fit argument isn't NULL

* Fix test
sbfnk pushed a commit that referenced this pull request May 3, 2024
* Point out deprecation of "cumulative" option

* Deprecate init_cumulative_fit function

* Add NEWS item

* Add PR number to NEWS item

* Linting: trailing white spaces

* Change versions

* Add deprecation warning for init_fit  argument

* Move deprecation statement to separate paragraph

* Add deprecation test

* Add reviewer

* Move deprecation warning to where the argument is called

* Revise deprecation message

* Don't use explicit namespacing

* Throw deprecation warning if init_fit argument isn't NULL

* Fix test
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.

Deprecate init_cumulative_fit
2 participants