Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scoring: Use N/A for recommended/optional, 0 is only a failure for Mandatory #292

Merged
merged 1 commit into from
Oct 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/source/evaluation.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,10 @@ For more info see: {ref}`is_standard`

You should score your TRE against each statement in the SATRE specification using this scoring system:

:0 Not met: The TRE does not meet this requirement (the TRE is not SATRE compliant)
:0 Not met: The TRE does not meet this requirement (if this is **Mandatory** this means the TRE is not SATRE compliant)
:1 Sufficient: The TRE meets this requirement met but there is substantial scope for improvement
:2 Satisfied: The TRE meets this requirement met but there may still be scope for improvement
:N/A: Not applicable: The statement is not relevant to a TRE, may apply to **Recommended** or **Optional** statements
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note if we return to #272 and use conditional Mandatory statements this will need to be updated, AFAIK currently all Mandatory statements are mandatory for all.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is right, there's probably statements in out eval where we gave ourselves a 2 and just said "we pass because it's not applicable" - I don't think this is a huge issue though


A score of **1** or above means you have met the requirement.
Optionally you can use **1** and **2** to indicate potential areas of improvement in your TRE.
Expand Down