The E12 data group have accepted a request from some users requesting the episode free text description to be made non-mandatory. The description field uses fuzzy logic to match any key words (taken from a validated list produced by the american international league against epilepsy ILAE group). The original reason to include the feature in the early build had been to do frequency analysis on terms in the free text and improve on this slightly odd and eclectic American list of terms (which includes words like 'fencers posture' but does not include words like 'shaking'). By making this an optional field, it seems unlikely now it will be completed by many users hence the sad face, and depending on how much it is completed, the validity of any data collected will be watered down. Sorry this is only an audit, I should possibly not be quite so involved...
Anyway, this PR removes the description field from the scoreable fields and amends the signposting to users to reflect this in the templates. It also updates the tests which check the form scoring.
Code changes
form_calculation_constants: this file stores the minimum scoreable fields. description is commented out with a reference to this issue for future.
recalculate_form_generate_response: omits `description from the scored fields
test files: these remove description from the totals
description.html and description_labels.html: update the tooltip and message to signpost to users that the field is optional.
Overview
The E12 data group have accepted a request from some users requesting the episode free text description to be made non-mandatory. The description field uses fuzzy logic to match any key words (taken from a validated list produced by the american international league against epilepsy ILAE group). The original reason to include the feature in the early build had been to do frequency analysis on terms in the free text and improve on this slightly odd and eclectic American list of terms (which includes words like 'fencers posture' but does not include words like 'shaking'). By making this an optional field, it seems unlikely now it will be completed by many users hence the sad face, and depending on how much it is completed, the validity of any data collected will be watered down. Sorry this is only an audit, I should possibly not be quite so involved...
Anyway, this PR removes the
descriptionfield from the scoreable fields and amends the signposting to users to reflect this in the templates. It also updates the tests which check the form scoring.Code changes
form_calculation_constants: this file stores the minimum scoreable fields.descriptionis commented out with a reference to this issue for future.recalculate_form_generate_response: omits `description from the scored fieldsdescription.htmlanddescription_labels.html: update the tooltip and message to signpost to users that the field is optional.Related Issues
closes #1015