Skip to content

Commit

Permalink
Docs, lint, reorganize changelog properly
Browse files Browse the repository at this point in the history
  • Loading branch information
@echeng06
echeng06 committed Nov 20, 2024
1 parent 6f75698 commit 314ed83
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 37 deletions.
20 changes: 10 additions & 10 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,36 @@ Documentation of release versions of `nacc-form-validator`

## 0.4.0

* Updates `_validate_compute_gds` to remove partial GDS score calculation
* Updates `_check_subschema_valid` to accept an optional record parameter, defaults to the document - used for rules that require the previous record
* Updates `compare_with` to support the `abs` operator
* Updates `compatibility` error message to be more verbose
* Refactors the tests to be more modularized so that they're more manageable
* Refactors logic for `compare_values` by moving it to its own utility method and allows comparing to null values
* Adds `get_previous_record` method to grab previous record from Datastore, which can grab the previous record or the previous record where a specific field is non-empty
* Updates `_validate_temporalrules` to also support the `ignore_empty` parameter
* Adds support for comparing against the previous record in `compare_with`
* Adds new rule `compare_age` to handle rules that need to compare ages relative to a date
* Adds custom operator `count_exact` to `json_logic.py`
* Refactors the tests to be more modularized so that they're more manageable
* Refactors logic for `compare_values` by moving it to its own utility method and allows comparing to null values
* Updates `_check_subschema_valid` to accept an optional record parameter, defaults to the document - used for rules that require the previous record
* Updates `_validate_compute_gds` to remove partial GDS score calculation
* Updates `_validate_compare_with` to support the `abs` operator
* Updates `_validate_compatibility` error message to be more verbose
* Updates `_validate_temporalrules` to also support `ignore_empty` and `swap_order` parameters
* Fixes issue where `datastore` was not being set for the temp validator in `_check_subschema_valid`, causing nested conditions with previous records to not evaluate correctly

## 0.3.0

* Adds `_check_with_rxnorm` function to check whether a given Drug ID is valid RXCUI code
* Updates `_validate_compare_with` to allow adjustments to be another field, and for base values to be hardcoded values
* Updates json_logic `less` function to handle None
* Updates `_validate_temporalrules` to iterate on multiple fields for `previous` and `current` clauses, remove `orderby` attribute
* Updates `_check_with_gds` function to `_validate_compute_gds` and update GDS score validation
* Adds `_check_with_rxnorm` function to check whether a given Drug ID is valid RXCUI code
* Fixes a bug in min/max validation wrt current_year

## 0.2.0

* Adds documentation/user guides and testing
* Adds this CHANGELOG
* Updates `_validate_compatibility` to iterate on multiple fields for `then` and `else` clauses, similar to how the `if` clause was handling it
* Updates `cast_record` to set any missing fields to `None`
* Updates `pants_version` in `pants.toml` to `2.22.0` (latest) to support building on macOS
* Renamed `validator` to `nacc_form_validator` for a more unique namespace, and imported `QualityCheck` into `__init__.py` for easier access
* Adds documentation/user guides and testing
* Adds this CHANGELOG

## 0.1.1 and older

Expand Down
56 changes: 35 additions & 21 deletions docs/data-quality-rule-definition-guidelines.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -854,38 +854,52 @@ The validator also has custom operators in addition to the ones provided by json
### temporalrules

Used to specify the list of checks to be performed against the previous visit for the same participant.
* Each constraint specifies `previous` and `current` attributes. If conditions specified under `previous` subschema satisfied by the previous visit record, then the current visit record must satisfy the conditions specified under `current` subschema.
* Each `previous/current` attribute can have several fields which need to be satisifed, with the optional `*_op` attribute specifying the boolean operation in which to compare the different fields. For example, if `prev_op = or`, then as long as _any_ of the fields satsify their schema, the `current` attribute will be evaluated. The default `*_op` is `and`.
* Each constraint also allows for an optional `ignore_empty` option, which can take a string or list of strings denoting fields that cannot be empty. When grabbing the previous record, the validator will grab the first previous record where all specified fields are non-empty.

Each constraint specifies `previous` and `current` attributes. If conditions specified under the `previous` subschema are satisfied by the previous visit record, then the current visit record must satisfy the conditions specified under `current` subschema.

Each constraint also has optional fields that can be set:

* Each `previous/current` attribute can have several fields which need to be satisifed, so an optional `*_op` attribute can be used to specify the boolean operation in which to compare the different fields. For example, if `prev_op = or`, then as long as _any_ of the fields satsify their schema, the `current` attribute will be evaluated. The default `*_op` is `and`.
* `ignore_empty`: Takes a string or list of strings denoting fields that cannot be empty. When grabbing the previous record, the validator will grab the first previous record where _all_ specified fields are non-empty.
* If no record is found that satisfies all fields being non-empty, the validator will _ignore_ the check (e.g. pass through validation without errors)
* `swap_order`: If set to True, it will swap the order of operations, evluating the `current` subschema first, then the `previous` subschema

*To validate `temporalrules`, the validator should have a `Datastore` instance which will be used to retrieve the previous visit record(s) for the participant.*
> **NOTE**: To validate `temporalrules`, the validator should have a `Datastore` instance which will be used to retrieve the previous visit record(s) for the participant.

The rule definition for `temporalrules` should follow the following format:

```json
{
"<parent_field_name>": {
"temporalrules": [
{
"previous": {
"<field_name>": "subschema to be satisfied for the previous record"
},
"current": {
"<field_name>": "subschema to be satisfied for the current record"
}
{
"previous": {
"<field_name>": "subschema to be satisfied for the previous record"
},
{
"ignore_empty": ["<field_name_1>", "<field_name_2>"],
"prev_op": "or",
"previous": {
"<field_name_1>": "subschema to be satisfied for the previous record",
"<field_name_2>": "subschema to be satisfied for the previous record"
},
"current": {
"<field_name>": "subschema to be satisfied for the current record"
}
"current": {
"<field_name>": "subschema to be satisfied for the current record, will be evaluated if the previous subschema is satisfied"
}
}, {
"ignore_empty": ["<field_name_1>", "<field_name_2>"],
"prev_op": "or",
"previous": {
"<field_name_1>": "subschema to be satisfied for the previous record",
"<field_name_2>": "subschema to be satisfied for the previous record"
},
"current": {
"<field_name>": "subschema to be satisfied for the current record, will be evaluated if either of the previous subschemas are satisfied"
}
},
{
"swap_order": true,
"previous": {
"<field_name>": "subschema to be satisfied for the previous record, will be evaluated if the current subschema is satisfied"
},
"current": {
"<field_name>": "subschema to be satisfied for the current record"
}
}

]
}
}
Expand Down
6 changes: 4 additions & 2 deletions nacc_form_validator/errors.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@ def __set_custom_error_codes(self):
0x1009:
"{1} for if {2} else {3} - compatibility rule no: {0}",
0x2000:
"{1} in current visit for if {2} in previous visit then {3} in current visit - temporal rule no: {0}",
"{1} in current visit for if {2} in previous visit then {3} " +
"in current visit - temporal rule no: {0}",
0x2001:
"primary key variable {0} not set in current visit data",
0x2002:
Expand Down Expand Up @@ -121,7 +122,8 @@ def __set_custom_error_codes(self):
0x3003:
"Error in comparing {0} to age at {1} ({2}): {3}",
0x3004:
"{1} in previous visit for if {2} in current visit then {3} in previous visit - temporal rule no: {0}",
"{1} in previous visit for if {2} in current visit then {3} " +
"in previous visit - temporal rule no: {0}",
}

self.messages.update(custom_errors)
Expand Down
10 changes: 6 additions & 4 deletions nacc_form_validator/nacc_validator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -736,8 +736,9 @@ def _validate_temporalrules(self, temporalrules: List[Mapping], field: str,

if not swap_order:
# Check if conditions for the previous visit is satisfied
valid, _ = self._check_subschema_valid(
prev_conds, prev_operator, record=prev_ins)
valid, _ = self._check_subschema_valid(prev_conds,
prev_operator,
record=prev_ins)

# If not satisfied, continue to next rule
if not valid:
Expand All @@ -757,8 +758,9 @@ def _validate_temporalrules(self, temporalrules: List[Mapping], field: str,
continue

# if satisfied, validate previous visit
valid, errors = self._check_subschema_valid(
prev_conds, prev_operator, record=prev_ins)
valid, errors = self._check_subschema_valid(prev_conds,
prev_operator,
record=prev_ins)

# Cross visit validation failed - report errors
if not valid and errors:
Expand Down

0 comments on commit 314ed83

Please sign in to comment.