Issue #750 - Introduce a forecast_type
argument in validate_forecast()
#751
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.
Description
As discussed in #750, it would be nice to have a way in
validate_forecast()
to check the type is exactly what you want.This PR therefore
forecast_type
argument invalidate_forecast()
, analogously to the one that already exists inas_forecast()
.assert_forecast_type()
that does exactly that, simplifying the code inas_forecast()
and minimising repetitive code invalidate_forecast()
. The rationale for the slightly odd design withactual
anddesired
is that that avoids runningget_forecast_type()
again in situations where the forecast type is already determined by the class of the object. An earlier version only had a single argumentforecast_type()
for the desired type and the actual type was determined automatically. This, however, presumes that validation works. I think both versions are fine if you have a preference 🤷Checklist
lintr::lint_package()
to check for style issues introduced by my changes.