update some annotations

HDRUK · May 15, 2024 · 53b4b0e · 53b4b0e
1 parent d549594
commit 53b4b0e
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 13 deletions.
diff --git a/docs/HDRUK/2.2.1.form.json b/docs/HDRUK/2.2.1.form.json
@@ -401,9 +401,11 @@
             },
             {
                   "required": false,
-                  "title": "Age Range",
+                  "title": "Typical Age Range",
                   "description": "Please indicate the age range in whole years of participants in the dataset. Please provide range in the following format '[min age] \u2013 [max age]' where both the minimum and maximum are whole numbers (integers).",
-                  "examples": null,
+                  "examples": [
+                        "18-90"
+                  ],
                   "is_list": false,
                   "is_optional": true,
                   "types": {

diff --git a/docs/HDRUK/2.2.1.md b/docs/HDRUK/2.2.1.md
@@ -348,11 +348,13 @@ Examples:
 
 Please indicate the age range in whole years of participants in the dataset. Please provide range in the following format '[min age] – [max age]' where both the minimum and maximum are whole numbers (integers).
 
-| title     | is_list   | is_optional   | required   | type                                                                                                                                                                                |
-|:----------|:----------|:--------------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Age Range | False     | True          | False      | ["AgeRange[{'anyOf': [{'pattern': 'Not Known|(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])-(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])', 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
+| title             | is_list   | is_optional   | required   | type                                                                                                                                                                                |
+|:------------------|:----------|:--------------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Typical Age Range | False     | True          | False      | ["AgeRange[{'anyOf': [{'pattern': 'Not Known|(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])-(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])', 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
 
+Examples: 
 
+   * 18-90
 
 
 ### followup

diff --git a/docs/HDRUK/2.2.1.structure.json b/docs/HDRUK/2.2.1.structure.json
@@ -444,9 +444,11 @@
                   {
                         "name": "typicalAgeRange",
                         "required": false,
-                        "title": "Age Range",
+                        "title": "Typical Age Range",
                         "description": "Please indicate the age range in whole years of participants in the dataset. Please provide range in the following format '[min age] \u2013 [max age]' where both the minimum and maximum are whole numbers (integers).",
-                        "examples": null,
+                        "examples": [
+                              "18-90"
+                        ],
                         "type": [
                               "AgeRange[{'anyOf': [{'pattern': 'Not Known|(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])-(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])', 'type': 'string'}, {'type': 'null'}]}]",
                               "null"

diff --git a/hdr_schemata/models/HDRUK/v2_1_2/annotations/config.yaml b/hdr_schemata/models/HDRUK/v2_1_2/annotations/config.yaml
@@ -73,3 +73,9 @@ enrichmentAndLinkage:
   tools:
     description: "Please provide the URL of any analysis tools or models that have been created for this dataset and are available for further use. Multiple tools may be provided. Note: We encourage users to adopt a model along the lines of https://www.ga4gh.org/news/tool-registry-service-api-enabling-an-interoperable-library-of-genomics-analysis-tools/"
     title: Tools
+
+coverage:
+  title: Coverage
+  typicalAgeRange:
+    examples:
+      - 18-90
diff --git a/hdr_schemata/utils/create_markdown.py b/hdr_schemata/utils/create_markdown.py
@@ -221,15 +221,15 @@ def remove_types(data):
 from hdr_schemata.models.GWDM.v1_2 import Gwdm12
 
 
-create_markdown(Hdruk220, "./docs/HDRUK/", "2.2.0")
+# create_markdown(Hdruk220, "./docs/HDRUK/", "2.2.0")
 create_markdown(Hdruk221, "./docs/HDRUK/", "2.2.1")
-create_markdown(Hdruk212, "./docs/HDRUK/", "2.1.2")
-create_markdown(Hdruk213, "./docs/HDRUK/", "2.1.3")
+# create_markdown(Hdruk212, "./docs/HDRUK/", "2.1.2")
+# create_markdown(Hdruk213, "./docs/HDRUK/", "2.1.3")
 
 from hdr_schemata.models.GWDM.v1_1 import Gwdm10
 from hdr_schemata.models.GWDM.v1_1 import Gwdm11
 from hdr_schemata.models.GWDM.v1_2 import Gwdm12
 
-create_markdown(Gwdm10, "./docs/GWDM/", "1.0")
-create_markdown(Gwdm11, "./docs/GWDM/", "1.1")
-create_markdown(Gwdm12, "./docs/GWDM/", "1.2")
+# create_markdown(Gwdm10, "./docs/GWDM/", "1.0")
+# create_markdown(Gwdm11, "./docs/GWDM/", "1.1")
+# create_markdown(Gwdm12, "./docs/GWDM/", "1.2")