align file_refit options with brms
#234
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GidonFrischkorn
commented
Aug 23, 2024
| @@ -45,11 +45,11 @@ | |||
| #' @param file_compress Logical or a character string, specifying one of the | |||
| #' compression algorithms supported by [saveRDS] when saving | |||
| #' the fitted model object. | |||
| #' @param file_refit Logical. Modifies when the fit stored via the `file` argument is | |||
| #' @param file_refit Logical or character string. Modifies when the fit stored via the `file` argument is | |||
There was a problem hiding this comment.
Can you check if these changes are correct! I was a little confused because previously the documentation states that file_refit = TRUE would lead to re-using a saved model, and file_refit = FALSE would refit the model. I would have expected to be exactly the other way around, and I think this is also what is implemented in the read_bmmfit function.
GidonFrischkorn
added
the
enhancement - change functionality
venpopov
approved these changes
Aug 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
file_refit. Throw a warning if "on_change" is passedTests
[x] Confirm that all tests passed
[x] Confirm that devtools::check() produces no errors
Release notes
file_refitargument of thebmmfunction now accepts character string like brms. A warning is given when "on_change" is specified, as this is not currently implemented forbmmodels.