Skip to content

Commit

Permalink
Adding more information on kurator-ffdq to the supplement. Adding a n…
Browse files Browse the repository at this point in the history
…ote in the supplement as to where the tags (github issue labels) can be found in BDQ Core.
  • Loading branch information
chicoreus committed Nov 12, 2024
1 parent c6ad530 commit a735b7d
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions tg2/_review/build/templates/supplement/supplement-header.md
Original file line number Diff line number Diff line change
Expand Up @@ -672,11 +672,13 @@ From [xkcd.com/2867](https://xkcd.com/2867/), by Randall Munroe, xkcd.com. Lice

The Tests were developed as issues in the tdwg/bdq GitHub environment. The reasoning was that GitHub provided a comprehensive and consistent environment in which to develop, expose, discuss and manage all aspects of the development of BDQ Core. We used a standard template as the first Comment on GitHub Issues pages for documenting all Tests. This immediately exposed all proposed tests to anyone following the work. GitHub then enabled anyone to comment on the Test issues, facilitating discussion. When there was general agreement among the Authors, the values within the template could be easily modified and documented. The comments in the issues served as a tool for rationale management, documenting why particular decisions were made about the tests during their development.

GitHub's API also provided ample latitude to 'scrape' and filter Issues using GitHub tags (see below) to extract any subset of Tests by Descriptors to CSV files that would be used in the submission and proposed maintenance of the BDQ Core standard. The [bdq_issue_to_csv](https://github.com/kurator-org/bdq_issue_to_csv) library (Morris 2024) uses GitHub's API to obtain a json representation of the GitHub issues, then parses the agreed upon format for markdown tables for describing issues into a CSV file (destined to be come the [term-version csv](../../vocabulary/bdqcore_term_versions.csv) file for the bdqcore: vocabulary. The [kurator-ffdq](https://github.com/kurator-org/kurator-ffdq) library (Lowery et al. 2024), which contains a Java representation of bdqffdq: classes is used to process the term-version file into RDF representations of the tests (e.g. [bdqcore.xml](../../dist/bdqcore.xml) (and can also query combined bdqffdq: and bdqcore: rdf, and can also execute appropriately annotated Java test implementations and produce data quality reports).
GitHub's API also provided ample latitude to 'scrape' and filter Issues using GitHub tags (see below) to extract any subset of Tests by Descriptors to CSV files that would be used in the submission and proposed maintenance of the BDQ Core standard. The [bdq_issue_to_csv](https://github.com/kurator-org/bdq_issue_to_csv) library (Morris 2024) uses GitHub's API to obtain a json representation of the GitHub issues, then parses the agreed upon format for markdown tables for describing issues into a CSV file (destined to be come the [term-version csv](../../vocabulary/bdqcore_term_versions.csv) file for the bdqcore: vocabulary. The [kurator-ffdq](https://github.com/kurator-org/kurator-ffdq) library (Lowery et al. 2024), which contains a Java representation of bdqffdq: classes is used to process the term-version file into RDF representations of the tests (e.g. [bdqcore.xml](../../dist/bdqcore.xml) (and can also query combined bdqffdq: and bdqcore: rdf, and can generate stub python and java methods for test implementations, and can also execute appropriately annotated Java test implementations and produce data quality reports).

### 5.2 Github Tags and Categorizing Issues

The development of each Test, with documentation of why particular decisions were made with regard to that test, has been documented in issues in the tdwg/bdq GitHub repository. Each Test issue was tagged with the following GitHub issue tags to assist in finding, evaluating, and asserting conclusions about each Test.
The development of each Test, with documentation of why particular decisions were made with regard to that test, has been documented in issues in the tdwg/bdq GitHub repository. Each Test issue was tagged with the following GitHub issue labels to assist in finding, evaluating, and asserting conclusions about each Test.

These tags are retained as the "Github Issue Labels" (a skos:note on each Method instance) in BDQ Core.

| tag | definition | comment |
| --- | ---------- | ------- |
Expand Down

0 comments on commit a735b7d

Please sign in to comment.