tdwg / bdq

Biodiversity Data Quality (BDQ) Interest Group
https://github.com/tdwg/bdq
43 stars 7 forks source link

TG2-AMENDMENT_PREPARATIONS_STANDARDIZED #280

Closed ArthurChapman closed 7 months ago

ArthurChapman commented 7 months ago
TestField Value
GUID 8d0cbfee-4524-4da3-83d4-bebc4c4f7cd2
Label AMENDMENT_PREPARATIONS_STANDARDIZED
Description Propose amendment to the value of dwc:preparations using bdq:sourceAuthority.
TestType Amendment
Darwin Core Class dwc:MaterialEntity
Information Elements ActedUpon dwc:preparations
Information Elements Consulted
Expected Response EXTERNAL_PREREQUISITES_NOT_MET if the bdq:sourceAuthority is not available; INTERNAL PREREQUISITES_NOT_MET if dwc:preparations is bdq:Empty; AMENDED the value of dwc:preparations if at least one item in the list of preparations, comparing and amending item by item in the list, ignoring leading or trailing whitespace in each item, can be unambiguously matched to a term in the bdq:sourceAuthority; otherwise NOT_AMENDED
Data Quality Dimension Conformance
Term-Actions PREPARATIONS_STANDARDIZED
Parameter(s) bdq:sourceAuthority
Source Authority bdq:sourceAuthority default = "Darwin Core preparations {[https://dwc.tdwg.org/list/#dwc_preparations]} {dwc:preparations vocabulary API [NO CURRENT API EXISTS]}
Specification Last Updated 2024-02-09
Examples [dwc:preparations="image": Response.status=AMENDED, Response.result=dwc:preparations="photograph", Response.comment="dwc:preparations contains an interpretable value in the bdq:sourceAuthority"]
[dwc:preparations="tree": Response.status=NOT_AMENDED, Response.result="", Response.comment="dwc:preparations does not contain an interpretable value in the bdq:sourceAuthority"]
Source TG2
References
Example Implementations (Mechanisms)
Link to Specification Source Code
Notes Currently, it appears that no full Vocabulary exists for dwc:preparations making this test difficult to implement. Best practice for dwc:preparations is a pipe delimited list, implementations should split the list into elements and test each element against the source authority. This bdq:Supplementary test is not regarded as CORE (cf. bdq:CORE) because of one or more of the reasons: not being widely applicable; not informative; not straightforward to implement or likely to return a high percentage of either bdq:COMPLIANT or bdq:NOT_COMPLIANT results (cf bdq:Response.result). A Supplementary test may be implemented as CORE when a suitable use case exists.
ArthurChapman commented 7 months ago

See comment under #279 on need for SourceAuthority API.

chicoreus commented 7 months ago

As with #279 needs consideration of dwc:preparation defined as a list of values, with best practice being a pipe separator. May need a parameter specifying accepted values for separators with pipe as default.

Phrasing about leading or trailing whitespace should not apply, separators, as in the examples in dwc:preparation, may include whitespace.

ArthurChapman commented 4 weeks ago

hanged MaterialEntity to dwc:MaterialEntity