Change behavior of the problem_recorder and driver_recorder options on dashboard command #320
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
crecine
approved these changes
Jun 17, 2024
aviary/visualization/dashboard.py
Outdated
| driver_recorder : str | ||
| Name of the recorder file containing the Driver cases. | ||
| driver_recorder : str or None | ||
| Name of the recorder file containing the Driver cases. If None, ignore this file |
There was a problem hiding this comment.
I'd prefer something more descriptive than "ignored", maybe something like:
Suggested change
| Name of the recorder file containing the Driver cases. If None, ignore this file | |
| Name of the recorder file containing the Driver cases. If None, the driver tab will not be added |
There was a problem hiding this comment.
Good suggestion! Fixed
|
#330 changed aviary/docs/user_guide/outputs_and_how_to_read_them from .md to .ipynb, if you need help resolving the merge conflict, let me know. |
…hange-recorder-name-dashboard-option-behavior
Kenneth-T-Moore
approved these changes
Jun 18, 2024
|
@hschilling Just created a PR to your branch to resolve the merge conflict, which should fix the doc failure |
|
Thanks! |
You'll have to approve it here |
Changed default name of problem recorder file to problem_history.db
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
Modified the way the dashboard command works so that the dashboard always uses the problem and driver case recorder files and that the problem_recorder and driver_recorder options be used to indicate that a non-standard name for the file was used. The exception to that is if driver_recorder is set to None, which would indicate not reading the driver recorder file, which could be very large and the resulting dashboard tab not of interest to the user.
Also changed the name of the default filenames to be
problem_history.dbanddriver_history.db.Related Issues
Backwards incompatibilities
None
New Dependencies
None