Skip to content

Commit

Permalink
don't change the keys of dataset linkage - only data type
Browse files Browse the repository at this point in the history
  • Loading branch information
@BSnelling
BSnelling committed Oct 21, 2024
1 parent 6caad0b commit 925df61
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 65 deletions.
18 changes: 9 additions & 9 deletions docs/GWDM/2.0.form.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -924,7 +924,7 @@
"title": "OneHundredFiftyCharacters",
"type": "string"
},
"location": "linkage.datasetLinkage.derivedFrom.pid"
"location": "linkage.datasetLinkage.isDerivedFrom.pid"
},
{
"required": false,
Expand All @@ -940,7 +940,7 @@
"title": "OneHundredFiftyCharacters",
"type": "string"
},
"location": "linkage.datasetLinkage.derivedFrom.title"
"location": "linkage.datasetLinkage.isDerivedFrom.title"
},
{
"required": false,
Expand All @@ -956,7 +956,7 @@
"minLength": 1,
"type": "string"
},
"location": "linkage.datasetLinkage.derivedFrom.url"
"location": "linkage.datasetLinkage.isDerivedFrom.url"
},
{
"required": false,
Expand Down Expand Up @@ -1020,7 +1020,7 @@
"title": "OneHundredFiftyCharacters",
"type": "string"
},
"location": "linkage.datasetLinkage.linkableDatasets.pid"
"location": "linkage.datasetLinkage.linkedDatasets.pid"
},
{
"required": false,
Expand All @@ -1036,7 +1036,7 @@
"title": "OneHundredFiftyCharacters",
"type": "string"
},
"location": "linkage.datasetLinkage.linkableDatasets.title"
"location": "linkage.datasetLinkage.linkedDatasets.title"
},
{
"required": false,
Expand All @@ -1052,7 +1052,7 @@
"minLength": 1,
"type": "string"
},
"location": "linkage.datasetLinkage.linkableDatasets.url"
"location": "linkage.datasetLinkage.linkedDatasets.url"
},
{
"required": false,
Expand All @@ -1068,7 +1068,7 @@
"title": "OneHundredFiftyCharacters",
"type": "string"
},
"location": "linkage.datasetLinkage.similarToDatasets.pid"
"location": "linkage.datasetLinkage.isMemberOf.pid"
},
{
"required": false,
Expand All @@ -1084,7 +1084,7 @@
"title": "OneHundredFiftyCharacters",
"type": "string"
},
"location": "linkage.datasetLinkage.similarToDatasets.title"
"location": "linkage.datasetLinkage.isMemberOf.title"
},
{
"required": false,
Expand All @@ -1100,7 +1100,7 @@
"minLength": 1,
"type": "string"
},
"location": "linkage.datasetLinkage.similarToDatasets.url"
"location": "linkage.datasetLinkage.isMemberOf.url"
},
{
"required": false,
Expand Down
20 changes: 12 additions & 8 deletions docs/GWDM/2.0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -821,13 +821,15 @@ Dataset Linkage copied over from



#### derivedFrom
#### isDerivedFrom

If applicable, please provide DOIs or links to datasets from which data in this dataset has been derived or calculated from.
Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset



Examples:

* Data will be minimised as appropriate relative to the data access application


##### pid
Expand Down Expand Up @@ -865,13 +867,13 @@ None

#### isPartOf

This relationship indicates that the dataset is a component or subset of a broader collection of related datasets. For example, clinical trial data for a specific drug may be part of a larger database of pharmaceutical research data. Complete only if the dataset is part of a group or family of datasets i.e. Hospital Episode Statistics has several constituents. If your dataset is not part of a group, please enter “NOT APPLICABLE” **Example**: Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS).
If the dataset is part of a group or family



Examples:

* Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS)
* UKCRC Tissue Directory and Coordination Centre


##### pid
Expand Down Expand Up @@ -907,13 +909,15 @@ None



#### linkableDatasets
#### linkedDatasets

If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked.
Links to other datasets.



Examples:

* Yes. To any SAIL dataset & reference data.,ALL


##### pid
Expand Down Expand Up @@ -949,9 +953,9 @@ None



#### similarToDatasets
#### isMemberOf

Datasets that are similar to each other in some way, collect similar patients, regional equivalent etc.
Dataset is a member of XXX(?)



Expand Down
32 changes: 18 additions & 14 deletions docs/GWDM/2.0.structure.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1121,12 +1121,14 @@
"is_optional": true,
"subItems": [
{
"name": "derivedFrom",
"name": "isDerivedFrom",
"required": false,
"title": "Derived from",
"description": "If applicable, please provide DOIs or links to datasets from which data in this dataset has been derived or calculated from.",
"title": "Derivations",
"description": "Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset",
"guidance": "",
"examples": null,
"examples": [
"Data will be minimised as appropriate relative to the data access application"
],
"type": [
"DatasetDescriptor"
],
Expand Down Expand Up @@ -1183,11 +1185,11 @@
{
"name": "isPartOf",
"required": false,
"title": "Is part of",
"description": "This relationship indicates that the dataset is a component or subset of a broader collection of related datasets. For example, clinical trial data for a specific drug may be part of a larger database of pharmaceutical research data. Complete only if the dataset is part of a group or family of datasets i.e. Hospital Episode Statistics has several constituents. If your dataset is not part of a group, please enter \u201cNOT APPLICABLE\u201d Example: Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS).",
"title": "Is PartOf",
"description": "If the dataset is part of a group or family",
"guidance": "",
"examples": [
"Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS)"
"UKCRC Tissue Directory and Coordination Centre"
],
"type": [
"DatasetDescriptor"
Expand Down Expand Up @@ -1243,12 +1245,14 @@
]
},
{
"name": "linkableDatasets",
"name": "linkedDatasets",
"required": false,
"title": "Linked datasets",
"description": "If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked.",
"title": "Linked Datasets",
"description": "Links to other datasets.",
"guidance": "",
"examples": null,
"examples": [
"Yes. To any SAIL dataset & reference data.,ALL"
],
"type": [
"DatasetDescriptor"
],
Expand Down Expand Up @@ -1303,10 +1307,10 @@
]
},
{
"name": "similarToDatasets",
"name": "isMemberOf",
"required": false,
"title": "Similar to datasets",
"description": "Datasets that are similar to each other in some way, collect similar patients, regional equivalent etc.",
"title": "Is MemberOf",
"description": "Dataset is a member of XXX(?)",
"guidance": "",
"examples": null,
"type": [
Expand Down
30 changes: 18 additions & 12 deletions hdr_schemata/models/GWDM/2.0/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@
"DatasetLinkage": {
"additionalProperties": false,
"properties": {
"derivedFrom": {
"isDerivedFrom": {
"anyOf": [
{
"items": {
Expand All @@ -560,8 +560,11 @@
}
],
"default": null,
"description": "If applicable, please provide DOIs or links to datasets from which data in this dataset has been derived or calculated from.",
"title": "Derived from"
"description": "Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset",
"examples": [
"Data will be minimised as appropriate relative to the data access application"
],
"title": "Derivations"
},
"isPartOf": {
"anyOf": [
Expand All @@ -576,13 +579,13 @@
}
],
"default": null,
"description": "This relationship indicates that the dataset is a component or subset of a broader collection of related datasets. For example, clinical trial data for a specific drug may be part of a larger database of pharmaceutical research data. Complete only if the dataset is part of a group or family of datasets i.e. Hospital Episode Statistics has several constituents. If your dataset is not part of a group, please enter \u201cNOT APPLICABLE\u201d **Example**: Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS).",
"description": "If the dataset is part of a group or family",
"examples": [
"Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS)"
"UKCRC Tissue Directory and Coordination Centre"
],
"title": "Is part of"
"title": "Is PartOf"
},
"linkableDatasets": {
"linkedDatasets": {
"anyOf": [
{
"items": {
Expand All @@ -595,10 +598,13 @@
}
],
"default": null,
"description": "If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked.",
"title": "Linked datasets"
"description": "Links to other datasets.",
"examples": [
"Yes. To any SAIL dataset & reference data.,ALL"
],
"title": "Linked Datasets"
},
"similarToDatasets": {
"isMemberOf": {
"anyOf": [
{
"items": {
Expand All @@ -611,8 +617,8 @@
}
],
"default": null,
"description": "Datasets that are similar to each other in some way, collect similar patients, regional equivalent etc.",
"title": "Similar to datasets"
"description": "Dataset is a member of XXX(?)",
"title": "Is MemberOf"
}
},
"title": "DatasetLinkage",
Expand Down
12 changes: 6 additions & 6 deletions hdr_schemata/models/GWDM/v2_0/DatasetLinkage.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ class DatasetLinkage(BaseModel):
class Config:
extra = "forbid"

derivedFrom: Optional[List[DatasetDescriptor]] = Field(
None, **an.derivedFrom.__dict__
isDerivedFrom: Optional[List[DatasetDescriptor]] = Field(
None, **an.isDerivedFrom.__dict__
)

isPartOf: Optional[List[DatasetDescriptor]] = Field(
None, **an.isPartOf.__dict__
)

linkableDatasets: Optional[List[DatasetDescriptor]] = Field(
None, **an.linkableDatasets.__dict__
linkedDatasets: Optional[List[DatasetDescriptor]] = Field(
None, **an.linkedDatasets.__dict__
)

similarToDatasets: Optional[List[DatasetDescriptor]] = Field(
None, **an.similarToDatasets.__dict__
isMemberOf: Optional[List[DatasetDescriptor]] = Field(
None, **an.isMemberOf.__dict__
)
36 changes: 20 additions & 16 deletions hdr_schemata/models/GWDM/v2_0/annotations/config.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -386,24 +386,28 @@ linkage:
- "https://digital.nhs.uk/services/data-access-request-service-dars/register-of-approved-data-releases"
title: "Investigations"

derivedFrom:
title: "Derived from"
description: "If applicable, please provide DOIs or links to datasets from which data in this dataset has been derived or calculated from."

isDerivedFrom:
description: "Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset"
examples:
- "Data will be minimised as appropriate relative to the data access application"
title: Derivations

isPartOf:
title: "Is part of"
description: "This relationship indicates that the dataset is a component or subset of a broader collection of related datasets. For example, clinical trial data for a specific drug may be part of a larger database of pharmaceutical research data. Complete only if the dataset is part of a group or family of datasets i.e. Hospital Episode Statistics has several constituents. If your dataset is not part of a group, please enter “NOT APPLICABLE” **Example**: Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS)."
examples:
- "Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS)"

similarToDatasets:
title: "Similar to datasets"
description: "Datasets that are similar to each other in some way, collect similar patients, regional equivalent etc."

linkableDatasets:
title: "Linked datasets"
description: "If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked."
description: "If the dataset is part of a group or family"
examples:
- "UKCRC Tissue Directory and Coordination Centre"
title: "Is PartOf"

isMemberOf:
description: "Dataset is a member of XXX(?)"
title: "Is MemberOf"

linkedDatasets:
description: "Links to other datasets."
examples:
- "Yes. To any SAIL dataset & reference data.,ALL"
title: "Linked Datasets"

syntheticDataWebLink:
description: Links to locations of information and or raw downloads of synthetic data associated with this dataset
title: "Synthetic Data Web Links"
Expand Down

0 comments on commit 925df61

Please sign in to comment.