Skip to content

Commit

Permalink
Cleaning up comments in key to vocablary terms in bdqcore, removing e…
Browse files Browse the repository at this point in the history
…mbedeed todo in commented out list of values that breaks the commenting out of that section, making section heading consistent with other vocabularies. Rebuilding generated documents.
  • Loading branch information
chicoreus committed Oct 30, 2024
1 parent 6b6a070 commit 3974822
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -124,17 +124,19 @@ There are four types of BDQ Core Tests: Validations, Issues, Amendments and Meas

**Measure Tests** either count things, or assert that data evaluate as fit for some use (COMPLETE), or not fit for some use (NOT_COMPLETE). An example is [MEASURE_VALIDATIONTESTS_NOTCOMPLIANT](https://rs.tdwg.org/bdqcore/terms/453844ae-9df4-439f-8e24-c52498eca84a) that returns the number of Tests of Type Validation that had a response of "NOT_COMPLIANT".

### 1.9 Test Descriptors
### 1.9 Key to Vocabulary Terms

The Test Descriptors are terms that are necessary to comprehensively describe each Test. Some terms, such as the IRI and term_localName are intended for machine consumption. Some terms such as the "Description" are designed to be human-readable and to be understood by consumers of biodiversity data quality reports. Terms such as the "Specification" ensure that implementers have no ambiguity about how the Test should be coded.
These "Test Descriptors" are terms that are necessary to comprehensively describe each Test. Some terms, such as the IRI and term_localName are intended for machine consumption. Some terms such as the "Description" are designed to be human-readable and to be understood by consumers of biodiversity data quality reports. Terms such as the "Specification" ensure that implementers have no ambiguity about how the Test should be coded.

{term_key}

<!--- TODO: Confirm that metadata for 1.8 has these values --->
<!--- TODO: Confirm that metadata for 1.9 has these values --->
<!---
In Section 4 the values of the rdfs:Label, skos:prefLabel, Versioned IRI,
Resource Type, Specification, Information Elements ActedUpon, Information
Elements Consulted, and Parameters are normative. The values of
Description, Examples, Use Cases, and Notes are non-normative.
--->

<!--- @Tasilee text for comparison with generated table. Some of these will need to be incorporated into definitions in the generated table.
Expand Down Expand Up @@ -168,7 +170,7 @@ Description, Examples, Use Cases, and Notes are non-normative.
**Type**. The type of the Test, one of Validation, Issue, Amendment or Mmeasure, for example "**VALIDATION**_DECIMALLONGITUDE_INRANGE"
**Resource Type**. The Test either operates on a Single Record or Multiple Records <!--- (TODO bdq...used here or keep it simple English) --->...this generally relates to this list.
**Resource Type**. The Test either operates on a Single Record or Multiple Records
**Dimension**. The Data Quality Dimension focus of the Test: One of "Completeness", "Conformance", "Consistency", "Likeliness", "Reliability" or "Resolution"
Expand Down
2 changes: 1 addition & 1 deletion tg2/_review/docs/extension/bdqffdq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ The following namespace abbreviations are used in this document:
| ------------ | ---------- | ------- | --------- |
| Name (rdf:value) | Idiomatic property used for structured values. | https://rs.tdwg.org/bdqffdq/terms/COMPLETE | normative |
| Type (rdf:type) | The subject is an instance of a class. | https://rs.tdwg.org/bdqffdq/terms/ResponseResult | normative |
| Range (rdfs:range) | A range of the subject property. In present context: shown as either a simple range in the form of a class, or as an owl:restriction in the form [ owl:someValuesFrom bdqffdq:targetedMeasure ]. | n69cd054623f34555a4b94d089bb4fed2b1 | normative |
| Range (rdfs:range) | A range of the subject property. In present context: shown as either a simple range in the form of a class, or as an owl:restriction in the form [ owl:someValuesFrom bdqffdq:targetedMeasure ]. | n2bad7f457eb5400cabacedbd68403bcab1 | normative |
| DifferentFrom (owl:differentFrom) | The property that determines that two given individuals are different. | https://rs.tdwg.org/bdqffdq/terms/NOT_COMPLETE | normative |
| Label (rdfs:label) | A human-readable name for the subject. | COMPLETE | normative |

Expand Down
18 changes: 9 additions & 9 deletions tg2/_review/docs/intro/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,13 +242,13 @@ There were many people who have made notable contributions at various times duri
- **Alexander Thompson (iDigBio)**: Key contributions to initial development of test descriptors; migrated test descriptors into markdown tables in github issues.
- **Yi-Ming Gan (Royal Belgian Institute of Natural Sciences)**: Contributed to test evaluation; explanatory workflow diagrams; editing BDQ Core documents.
- **António Mauro Saraiva (Universidade de São Paulo)**: Co-convenor of the TDWG Data Quality Interest Group; development of the Framework for Data Quality (TDWG Data Quality Task Group 1); facilitated test development workshop.
- **Alan Koch Veiga (Universidade de São Paulo)**: Developed the Framework on Data Quality as his disertation (Veiga 2016), Convener of the TDWG Data Quality Task Group 1 (Framework for Data Quality);
- **David Lowery (Museum of Comparative Zoology, Harvard University)**: Initial development of ontology reprentation of Framework on Data Quality; developer of kurator-ffdq Java class representation of the framework.
- **Alan Koch Veiga (Universidade de São Paulo)**: Developed the Framework on Data Quality as his dissertation (Veiga 2016), Convener of the TDWG Data Quality Task Group 1 (Framework for Data Quality).
- **David Lowery (Museum of Comparative Zoology, Harvard University)**: Initial development of ontology reprentation of Framework on Data Quality; developer of kurator-ffdq Java class representation of the Framework.
- **Christian Gendreau (Agriculture and Agri-Food Canada)**: Intitial contribitions to data quality discussions; vocabulary definitions and early test development.
- **Tim Roberston (Global Biodiversity Information Facility)**: Contributions to test descriptions; clarification of GBIF vocabulary and API resources for the BDQ Core Tsts.
- **Dmitry Schigel (Global Biodiversity Information Facility)**: Intitial contribitions to data quality discussions and vocabulary definitions; GBIF Representative to the Data Quality Interest Group in early years.
- **Robert A. Morris (late, of UMass Boston)**: Competency questions for the ontology of the Data Quality Framework; guided intital development of the ontology representation of the framework.
- **Miles Nicholls (Atlas of Living Australia)**: Convener of TDWG Data Quality Task Group 3 (Data Quality Use Cases); use Case analysis.
- **Robert A. Morris (late, of UMass Boston)**: Competency questions for the ontology of the Data Quality Framework; guided intital development of the ontology representation of the Framework.
- **Miles Nicholls (Atlas of Living Australia)**: Convener of TDWG Data Quality Task Group 3 (Data Quality Use Cases); Use Case analysis.
- **Emily Rose Rees (Atlas of Living Australia)**: Use Case analysis in TDWG Data Quality Task Group 3 (Data Quality Use Cases).
- **Abigail Benson (U.S. Geological Survey)**: Intitial contribitions to data quality discussions and vocabulary definitions.

Expand All @@ -267,10 +267,10 @@ There were many people who have made notable contributions at various times duri
| IRI | Internationalized Resource Identifier |
| ISO | International Standards Organization |
| TDWG | Biodiversity Information Standards |
| TG1 | Biodiversity Data Quality Task Group Task Group 1: Framework on Data Quality |
| TG2 | Biodiversity Data Quality Task Group Task Group 2: Data Quality Tests and Assertions |
| TG3 | Biodiversity Data Quality Task Group Task Group 3: Data Quality Use Cases |
| TG4 | Biodiversity Data Quality Task Group Task Group 4: Best Practices for Development of Vocabularies of Value |
| TG1 | Biodiversity Data Quality Interest Group - Task Group 1: Framework on Data Quality |
| TG2 | Biodiversity Data Quality Interest Group - Task Group 2: Data Quality Tests and Assertions |
| TG3 | Biodiversity Data Quality Interest Group - Task Group 3: Data Quality Use Cases |
| TG4 | Biodiversity Data Quality Interest Group - Task Group 4: Best Practices for Development of Vocabularies of Value |

## 6 Glossary

Expand Down Expand Up @@ -309,7 +309,7 @@ Glossary of terms used in BDQ Core that are additional to those included in the
| CRS | Coordinate Reference System - (also referred to as 'spatial reference system'). A coordinate system defined in relation to a standard reference or datum (Chapman & Wieczorek 2020). | Test |
| geodetic coordinate reference system | A coordinate reference system based on a geodetic datum, used to describe positions on the surface of the earth (Chapman and Wieczorek 2020). | Test |
| geodetic datum | A mathematical model that uses a reference ellipsoid to describe the size and shape of the surface of the earth and adds to it the information needed for the origin and orientation of coordinate systems on that surface (Chapman and Wieczorek 2000). | Test |
| Framework | The body of work that provides a framework for most of BDQ Core, and is the outcome of the TDWG Data Quality Task Group 1 (Framework on Data Quality. See Veiga et al. 2017 | bdqffdq: |
| Framework | The body of work that provides a framework for most of BDQ Core, and is the outcome of the TDWG Data Quality Task Group 1: Framework on Data Quality (Veiga et al. 2017). | bdqffdq: |
| GEOGRAPHY | A general category of specific bdq:InformationElements that represents a combination of Darwin Core administrative geography terms dwc:continent, dwc:country, dwc:countryCode, dwc:stateProvince, dwc:county, dwc:municipality. | bdqffdq:InformationElement |
| Java | Java is a registered trademark of Oracle and/or its affiliates. | BDQ Core |
| non-printing characters | ASCII 0-32 and 127 decimal. Non printing characters or formatting marks that are not displayed at printing. These may include pilcrow, space, non-breaking space, tab character. etc. For the purposes of the tests they are treated as bdq:Empty. | Data |
Expand Down
12 changes: 7 additions & 5 deletions tg2/_review/docs/list/bdqcore/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Draft Standard for Submission
- [1.6 RFC 2119 key words](#16-rfc-2119-key-words)
- [1.7 Namespace abbreviations](#17-namespace-abbreviations)
- [1.8 Types of Tests](#18-types-of-tests)
- [1.9 Test Descriptors](#19-test-descriptors)
- [1.9 Key to Vocabulary Terms](#19-key-to-vocabulary-terms)
- [2 Normative Guidance](#2-normative-guidance)
- [3 Term Indices](#3-term-indices)
- [3.1 Index By Term Name](#31-index-by-term-name)
Expand Down Expand Up @@ -138,9 +138,9 @@ There are four types of BDQ Core Tests: Validations, Issues, Amendments and Meas

**Measure Tests** either count things, or assert that data evaluate as fit for some use (COMPLETE), or not fit for some use (NOT_COMPLETE). An example is [MEASURE_VALIDATIONTESTS_NOTCOMPLIANT](https://rs.tdwg.org/bdqcore/terms/453844ae-9df4-439f-8e24-c52498eca84a) that returns the number of Tests of Type Validation that had a response of "NOT_COMPLIANT".

### 1.9 Test Descriptors
### 1.9 Key to Vocabulary Terms

The Test Descriptors are terms that are necessary to comprehensively describe each Test. Some terms, such as the IRI and term_localName are intended for machine consumption. Some terms such as the "Description" are designed to be human-readable and to be understood by consumers of biodiversity data quality reports. Terms such as the "Specification" ensure that implementers have no ambiguity about how the Test should be coded.
These "Test Descriptors" are terms that are necessary to comprehensively describe each Test. Some terms, such as the IRI and term_localName are intended for machine consumption. Some terms such as the "Description" are designed to be human-readable and to be understood by consumers of biodiversity data quality reports. Terms such as the "Specification" ensure that implementers have no ambiguity about how the Test should be coded.

| Label (Term) | Definition | Example | Normative |
| ------------ | ---------- | ------- | --------- |
Expand Down Expand Up @@ -178,11 +178,13 @@ The Test Descriptors are terms that are necessary to comprehensively describe ea
| Developed As Github Issue (skos:historyNote) | A note about the past state/use/meaning of a concept. In present context: A link to the github issue that provides a history (changes and comments) of the development of the test. | https://api.github.com/repos/tdwg/bdq/issues/32 | |


<!--- TODO: Confirm that metadata for 1.8 has these values --->
<!--- TODO: Confirm that metadata for 1.9 has these values --->
<!---
In Section 4 the values of the rdfs:Label, skos:prefLabel, Versioned IRI,
Resource Type, Specification, Information Elements ActedUpon, Information
Elements Consulted, and Parameters are normative. The values of
Description, Examples, Use Cases, and Notes are non-normative.
--->

<!--- @Tasilee text for comparison with generated table. Some of these will need to be incorporated into definitions in the generated table.

Expand Down Expand Up @@ -216,7 +218,7 @@ Description, Examples, Use Cases, and Notes are non-normative.

**Type**. The type of the Test, one of Validation, Issue, Amendment or Mmeasure, for example "**VALIDATION**_DECIMALLONGITUDE_INRANGE"

**Resource Type**. The Test either operates on a Single Record or Multiple Records <!--- (TODO bdq...used here or keep it simple English) --->...this generally relates to this list.
**Resource Type**. The Test either operates on a Single Record or Multiple Records

**Dimension**. The Data Quality Dimension focus of the Test: One of "Completeness", "Conformance", "Consistency", "Likeliness", "Reliability" or "Resolution"

Expand Down

0 comments on commit 3974822

Please sign in to comment.