From 1ec31c9d3c5021a49af068606780955d7363d305 Mon Sep 17 00:00:00 2001 From: Branwen Snelling Date: Thu, 10 Oct 2024 14:08:56 +0100 Subject: [PATCH] update doi examples to be valid ones --- docs/HDRUK/3.0.0.form.json | 8 ++++---- docs/HDRUK/3.0.0.md | 16 ++++++++-------- docs/HDRUK/3.0.0.structure.json | 8 ++++---- hdr_schemata/models/HDRUK/3.0.0/schema.json | 14 ++++++++------ .../models/HDRUK/v3_0_0/annotations/config.yaml | 8 ++++---- 5 files changed, 28 insertions(+), 26 deletions(-) diff --git a/docs/HDRUK/3.0.0.form.json b/docs/HDRUK/3.0.0.form.json index 7d833e7..9166800 100644 --- a/docs/HDRUK/3.0.0.form.json +++ b/docs/HDRUK/3.0.0.form.json @@ -1548,9 +1548,9 @@ "required": false, "title": "Publication about the dataset", "description": "DOIs for publications which describe the dataset.", - "guidance": "- Please provide the DOIs for publications which describe the dataset.\\n- Please split your existing list of citations into separate fields.\\n- To add multiple entries, type in each citation and press enter to add it to the list.\\n- **Example**: ", + "guidance": "- Please provide the DOIs for publications which describe the dataset.\\n- Please split your existing list of citations into separate fields.\\n- To add multiple entries, type in each citation and press enter to add it to the list.\\n- **Example**: <10.1093/ije/dyab028>", "examples": [ - "https://doi.org/10.1093/ije/dyab028" + "10.1093/ije/dyab028" ], "is_list": true, "is_optional": true, @@ -1565,9 +1565,9 @@ "required": false, "title": "Publication using the dataset", "description": "DOIs for publications which use the dataset for analysis.", - "guidance": "- Please provide the DOIs for publications which have used the dataset in their analysis.\\n- Please split your existing list of citations into separate fields.\\n- To add multiple entries, type in each citation and press enter to add it to the list.\\n- **Example**: ", + "guidance": "- Please provide the DOIs for publications which have used the dataset in their analysis.\\n- Please split your existing list of citations into separate fields.\\n- To add multiple entries, type in each citation and press enter to add it to the list.\\n- **Example**: <10.1001/jamapediatrics.2016.3633>", "examples": [ - "https://doi.org/10.1001/jamapediatrics.2016.3633" + "10.1001/jamapediatrics.2016.3633" ], "is_list": true, "is_optional": true, diff --git a/docs/HDRUK/3.0.0.md b/docs/HDRUK/3.0.0.md index 9413361..b6ed61a 100644 --- a/docs/HDRUK/3.0.0.md +++ b/docs/HDRUK/3.0.0.md @@ -971,26 +971,26 @@ Please provide the URL of any analysis tools or models that have been created fo DOIs for publications which describe the dataset. -| title | guidance | is_list | required | type | -|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------| -| Publication about the dataset | - Please provide the DOIs for publications which describe the dataset.
- Please split your existing list of citations into separate fields.
- To add multiple entries, type in each citation and press enter to add it to the list.
- **Example**: | True | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]"] | +| title | guidance | is_list | required | type | +|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------| +| Publication about the dataset | - Please provide the DOIs for publications which describe the dataset.
- Please split your existing list of citations into separate fields.
- To add multiple entries, type in each citation and press enter to add it to the list.
- **Example**: <10.1093/ije/dyab028> | True | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]"] | Examples: - * https://doi.org/10.1093/ije/dyab028 + * 10.1093/ije/dyab028 ### publicationUsingDataset DOIs for publications which use the dataset for analysis. -| title | guidance | is_list | required | type | -|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------| -| Publication using the dataset | - Please provide the DOIs for publications which have used the dataset in their analysis.
- Please split your existing list of citations into separate fields.
- To add multiple entries, type in each citation and press enter to add it to the list.
- **Example**: | True | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]"] | +| title | guidance | is_list | required | type | +|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------| +| Publication using the dataset | - Please provide the DOIs for publications which have used the dataset in their analysis.
- Please split your existing list of citations into separate fields.
- To add multiple entries, type in each citation and press enter to add it to the list.
- **Example**: <10.1001/jamapediatrics.2016.3633> | True | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]"] | Examples: - * https://doi.org/10.1001/jamapediatrics.2016.3633 + * 10.1001/jamapediatrics.2016.3633 ## observations diff --git a/docs/HDRUK/3.0.0.structure.json b/docs/HDRUK/3.0.0.structure.json index 29e50a9..0159302 100644 --- a/docs/HDRUK/3.0.0.structure.json +++ b/docs/HDRUK/3.0.0.structure.json @@ -1305,9 +1305,9 @@ "required": false, "title": "Publication about the dataset", "description": "DOIs for publications which describe the dataset.", - "guidance": "Please provide the DOIs for publications which describe the dataset.- Please split your existing list of citations into separate fields.- To add multiple entries, type in each citation and press enter to add it to the list.- Example: https://doi.org/10.1093/ije/dyab028", + "guidance": "Please provide the DOIs for publications which describe the dataset.- Please split your existing list of citations into separate fields.- To add multiple entries, type in each citation and press enter to add it to the list.- Example: <10.1093/ije/dyab028>", "examples": [ - "https://doi.org/10.1093/ije/dyab028" + "10.1093/ije/dyab028" ], "type": [ "Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]" @@ -1321,9 +1321,9 @@ "required": false, "title": "Publication using the dataset", "description": "DOIs for publications which use the dataset for analysis.", - "guidance": "Please provide the DOIs for publications which have used the dataset in their analysis.- Please split your existing list of citations into separate fields.- To add multiple entries, type in each citation and press enter to add it to the list.- Example: https://doi.org/10.1001/jamapediatrics.2016.3633", + "guidance": "Please provide the DOIs for publications which have used the dataset in their analysis.- Please split your existing list of citations into separate fields.- To add multiple entries, type in each citation and press enter to add it to the list.- Example: <10.1001/jamapediatrics.2016.3633>", "examples": [ - "https://doi.org/10.1001/jamapediatrics.2016.3633" + "10.1001/jamapediatrics.2016.3633" ], "type": [ "Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]" diff --git a/hdr_schemata/models/HDRUK/3.0.0/schema.json b/hdr_schemata/models/HDRUK/3.0.0/schema.json index 25190eb..cfe83bb 100644 --- a/hdr_schemata/models/HDRUK/3.0.0/schema.json +++ b/hdr_schemata/models/HDRUK/3.0.0/schema.json @@ -349,7 +349,6 @@ "type": "array" } ], - "default": null, "description": "The geographical area covered by the dataset. It is recommended that links are to entries in one of the recommended standards:- For locations in the UK: ONS standards- For locations in other countries: ISO 3166-1 & ISO 3166-2", "examples": [ "https://www.geonames.org/2635167/united-kingdom-of-great-britain-and-northern-ireland.html" @@ -454,6 +453,9 @@ "title": "Patient pathway description" } }, + "required": [ + "spatial" + ], "title": "Coverage", "type": "object" }, @@ -1116,9 +1118,9 @@ "default": null, "description": "DOIs for publications which describe the dataset.", "examples": [ - "https://doi.org/10.1093/ije/dyab028" + "10.1093/ije/dyab028" ], - "guidance": "Please provide the DOIs for publications which describe the dataset.- Please split your existing list of citations into separate fields.- To add multiple entries, type in each citation and press enter to add it to the list.- Example: https://doi.org/10.1093/ije/dyab028", + "guidance": "Please provide the DOIs for publications which describe the dataset.- Please split your existing list of citations into separate fields.- To add multiple entries, type in each citation and press enter to add it to the list.- Example: <10.1093/ije/dyab028>", "title": "Publication about the dataset" }, "publicationUsingDataset": { @@ -1136,9 +1138,9 @@ "default": null, "description": "DOIs for publications which use the dataset for analysis.", "examples": [ - "https://doi.org/10.1001/jamapediatrics.2016.3633" + "10.1001/jamapediatrics.2016.3633" ], - "guidance": "Please provide the DOIs for publications which have used the dataset in their analysis.- Please split your existing list of citations into separate fields.- To add multiple entries, type in each citation and press enter to add it to the list.- Example: https://doi.org/10.1001/jamapediatrics.2016.3633", + "guidance": "Please provide the DOIs for publications which have used the dataset in their analysis.- Please split your existing list of citations into separate fields.- To add multiple entries, type in each citation and press enter to add it to the list.- Example: <10.1001/jamapediatrics.2016.3633>", "title": "Publication using the dataset" } }, @@ -2269,7 +2271,6 @@ "type": "string" } ], - "default": null, "description": "The start of the time period that the dataset provides coverage for. If there are multiple cohorts in the dataset with varying start dates, please provide the earliest date and use the description or the media attribute to provide more information.", "guidance": "The start of the time period that the dataset provides coverage for.- If there are multiple cohorts in the dataset with varying start dates, please provide the earliest date and use the description or the media attribute to provide more information.", "title": "Start date" @@ -2309,6 +2310,7 @@ }, "required": [ "publishingFrequency", + "startDate", "timeLag" ], "title": "Temporal", diff --git a/hdr_schemata/models/HDRUK/v3_0_0/annotations/config.yaml b/hdr_schemata/models/HDRUK/v3_0_0/annotations/config.yaml index 4147cf6..3b17b56 100644 --- a/hdr_schemata/models/HDRUK/v3_0_0/annotations/config.yaml +++ b/hdr_schemata/models/HDRUK/v3_0_0/annotations/config.yaml @@ -304,16 +304,16 @@ enrichmentAndLinkage: publicationAboutDataset: - guidance: "- Please provide the DOIs for publications which describe the dataset.\\n- Please split your existing list of citations into separate fields.\\n- To add multiple entries, type in each citation and press enter to add it to the list.\\n- **Example**: " + guidance: "- Please provide the DOIs for publications which describe the dataset.\\n- Please split your existing list of citations into separate fields.\\n- To add multiple entries, type in each citation and press enter to add it to the list.\\n- **Example**: <10.1093/ije/dyab028>" title: "Publication about the dataset" examples: - - "https://doi.org/10.1093/ije/dyab028" + - "10.1093/ije/dyab028" description: "DOIs for publications which describe the dataset." publicationUsingDataset: - guidance: "- Please provide the DOIs for publications which have used the dataset in their analysis.\\n- Please split your existing list of citations into separate fields.\\n- To add multiple entries, type in each citation and press enter to add it to the list.\\n- **Example**: " + guidance: "- Please provide the DOIs for publications which have used the dataset in their analysis.\\n- Please split your existing list of citations into separate fields.\\n- To add multiple entries, type in each citation and press enter to add it to the list.\\n- **Example**: <10.1001/jamapediatrics.2016.3633>" title: "Publication using the dataset" examples: - - "https://doi.org/10.1001/jamapediatrics.2016.3633" + - "10.1001/jamapediatrics.2016.3633" description: "DOIs for publications which use the dataset for analysis."