pulsatrix 1.1.0
Loading...
Searching...
No Matches
pulsatrix::CheckResult Struct Reference

One check's result. More...

#include <explanation_report.hpp>

Public Member Functions

std::optional< double > value (std::string_view key) const
 The value named key, or std::nullopt.
 

Public Attributes

std::string name
 The PlannedCheck's name: "faithfulness", "randomization", ...
 
CheckPriority priority = CheckPriority::Recommended
 
CheckOutcome outcome = CheckOutcome::NotRun
 
std::string summary
 One or two sentences: what was found, or why it didn't run.
 
std::vector< std::pair< std::string, double > > values
 The numbers behind the outcome, in a fixed order: "p_value", "deletion_auc", ...
 

Detailed Description

One check's result.

Member Function Documentation

◆ value()

std::optional< double > pulsatrix::CheckResult::value ( std::string_view  key) const

The value named key, or std::nullopt.

Member Data Documentation

◆ name

std::string pulsatrix::CheckResult::name

The PlannedCheck's name: "faithfulness", "randomization", ...

◆ outcome

CheckOutcome pulsatrix::CheckResult::outcome = CheckOutcome::NotRun

◆ priority

CheckPriority pulsatrix::CheckResult::priority = CheckPriority::Recommended

◆ summary

std::string pulsatrix::CheckResult::summary

One or two sentences: what was found, or why it didn't run.

◆ values

std::vector<std::pair<std::string, double> > pulsatrix::CheckResult::values

The numbers behind the outcome, in a fixed order: "p_value", "deletion_auc", ...


The documentation for this struct was generated from the following file: