Skip to content

Commit

Permalink
Merge pull request #68 from HDRUK/bes/doi_examples
Browse files Browse the repository at this point in the history 
Update doi examples to be valid ones
  • Loading branch information
@BSnelling
BSnelling authored Oct 10, 2024
2 parents 1433b57 + 1ec31c9 commit d8662cb
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 26 deletions.
8 changes: 4 additions & 4 deletions docs/HDRUK/3.0.0.form.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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**: <https://doi.org/10.1093/ije/dyab028>",
"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,
Expand All @@ -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**: <https://doi.org/10.1001/jamapediatrics.2016.3633>",
"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,
Expand Down
16 changes: 8 additions & 8 deletions docs/HDRUK/3.0.0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br>- Please split your existing list of citations into separate fields.<br>- To add multiple entries, type in each citation and press enter to add it to the list.<br>- **Example**: <https://doi.org/10.1093/ije/dyab028> | 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.<br>- Please split your existing list of citations into separate fields.<br>- To add multiple entries, type in each citation and press enter to add it to the list.<br>- **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.<br>- Please split your existing list of citations into separate fields.<br>- To add multiple entries, type in each citation and press enter to add it to the list.<br>- **Example**: <https://doi.org/10.1001/jamapediatrics.2016.3633> | 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.<br>- Please split your existing list of citations into separate fields.<br>- To add multiple entries, type in each citation and press enter to add it to the list.<br>- **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
Expand Down
8 changes: 4 additions & 4 deletions docs/HDRUK/3.0.0.structure.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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'}]}]"
Expand All @@ -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'}]}]"
Expand Down
14 changes: 8 additions & 6 deletions hdr_schemata/models/HDRUK/3.0.0/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -454,6 +453,9 @@
"title": "Patient pathway description"
}
},
"required": [
"spatial"
],
"title": "Coverage",
"type": "object"
},
Expand Down Expand Up @@ -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": {
Expand All @@ -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"
}
},
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -2309,6 +2310,7 @@
},
"required": [
"publishingFrequency",
"startDate",
"timeLag"
],
"title": "Temporal",
Expand Down
8 changes: 4 additions & 4 deletions hdr_schemata/models/HDRUK/v3_0_0/annotations/config.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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**: <https://doi.org/10.1093/ije/dyab028>"
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**: <https://doi.org/10.1001/jamapediatrics.2016.3633>"
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."


Expand Down

0 comments on commit d8662cb

Please sign in to comment.