Closed Colelyman closed 4 months ago
It would be great to style the guard rails using the Bootstrap alert
class at the top of the report.
<div class="alert alert-danger" role="alert">
This is a danger alert—check it out!
</div>
Source: https://getbootstrap.com/docs/4.0/components/alerts/
The goal of the guard rails is to provide users with informative warnings when their analysis could potentially be compromised. We want to create a system where we can have multiple guard rails for different conditions. These warning should be displayed at the end of the shell output as well as in the report so that they are readily apparent.
Some thought should be taken as to how we implement the guard rails. We could have a class for each guard rail that inherits from a parent guard rail class that handles the display of the warning message. I'm open to other ideas on how to implement this.
We should add a new section to the
crispresso2_info['run_data']
object to hold all of the guard rail messages. This will make it easy to display the messages in report.Guard Rails
Here are some guard rails that we can implement first.