Skip to content

Commit

Permalink
updates to form json creation
Browse files Browse the repository at this point in the history
  • Loading branch information
@BSnelling
BSnelling committed May 15, 2024
1 parent 53b4b0e commit f8cda20
Show file tree
Hide file tree
Showing 5 changed files with 107 additions and 249 deletions.
159 changes: 5 additions & 154 deletions docs/HDRUK/2.2.1.form.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,16 +68,6 @@
},
"location": "revisions.url"
},
{
"required": true,
"title": "Metadata Version Revisions",
"description": "A list of persistent identifiers and version numbers for previous versions of metadata for this dataset",
"examples": null,
"is_list": true,
"is_optional": false,
"types": "Revision",
"location": "revisions"
},
{
"required": true,
"title": "Metadata Issued Datetime',",
Expand Down Expand Up @@ -224,16 +214,6 @@
},
"location": "summary.publisher.memberOf"
},
{
"required": true,
"title": "Dataset publisher",
"description": "This is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata. In most this will be the same as the HDR UK Organisation (Hub or Alliance Member). However, in some cases this will be different i.e. Tissue Directory are an HDR UK Gateway organisation but coordinate activities across a number of data publishers i.e. Cambridge Blood and Stem Cell Biobank.",
"examples": null,
"is_list": false,
"is_optional": false,
"types": "Organisation",
"location": "summary.publisher"
},
{
"required": true,
"title": "Contact Point",
Expand Down Expand Up @@ -401,7 +381,7 @@
},
{
"required": false,
"title": "Typical Age Range",
"title": "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": [
"18-90"
Expand Down Expand Up @@ -1001,16 +981,6 @@
},
"location": "accessibility.formatAndStandards.format"
},
{
"required": false,
"title": "Format and Standards",
"description": "Section includes technical attributes for language vocabularies, sizes etc. and gives researchers facts about and processing the underlying data in the dataset.",
"examples": null,
"is_list": false,
"is_optional": true,
"types": "FormatAndStandards",
"location": "accessibility.formatAndStandards"
},
{
"required": false,
"title": "Linked Datasets",
Expand Down Expand Up @@ -1068,16 +1038,6 @@
},
"location": "enrichmentAndLinkage.syntheticDataWebLink"
},
{
"required": false,
"title": "Enrichment and Linkage",
"description": "This section includes information about related datasets that may have previously been linked, as well as indicating if there is the opportunity to link to other datasets in the future. If a dataset has been enriched and/or derivations, scores and existing tools are available this section allows providers to indicate this to researchers.",
"examples": null,
"is_list": false,
"is_optional": true,
"types": "EnrichmentAndLinkage",
"location": "enrichmentAndLinkage"
},
{
"required": true,
"title": "Statistical Population'",
Expand Down Expand Up @@ -1140,102 +1100,13 @@
"is_list": false,
"is_optional": false,
"types": {
"title": "MeasuredProperty"
"maxLength": 100,
"minLength": 1,
"title": "MeasuredProperty",
"type": "string"
},
"location": "observations.measuredProperty"
},
{
"required": true,
"title": "Observations",
"description": "Multiple observations about the dataset may be provided and users are expected to provide at least one observation \n(1..*). We will be supporting the schema.org observation model (https://schema.org/Observation) with default values. Users will be encouraged to provide their own statistical populations as the project progresses. \nExample: \n <b> Statistical Population 1 \n </b> type: StatisticalPopulation populationType: Persons numConstraints: 0 \n <b> Statistical Population 2 </b> type: StatisticalPopulation populationType: Events numConstraints: 0 <b> Statistical Population 3 </b> type: StatisticalPopulation populationType: Findings numConstraints: 0 typeOf: Observation observedNode: <b> Statistical Population 1 </b> measuredProperty: count measuredValue: 32937 observationDate: \u201c2017\u201d\"\n",
"examples": null,
"is_list": true,
"is_optional": false,
"types": "Observation",
"location": "observations"
},
{
"required": true,
"title": "Table Name",
"description": "The name of a table in a dataset.",
"examples": null,
"is_list": false,
"is_optional": true,
"types": "str",
"location": "structuralMetadata.name"
},
{
"required": false,
"title": "Table Name",
"description": "The name of a table in a dataset.",
"examples": null,
"is_list": false,
"is_optional": true,
"types": "str",
"location": "structuralMetadata.description"
},
{
"required": true,
"title": "Column Name",
"description": "The name of a column in a table.",
"examples": null,
"is_list": false,
"is_optional": false,
"types": {
"title": "Name"
},
"location": "structuralMetadata.elements.name"
},
{
"required": true,
"title": "Data Type",
"description": "The data type of values in the column",
"examples": null,
"is_list": false,
"is_optional": false,
"types": "str",
"location": "structuralMetadata.elements.dataType"
},
{
"required": false,
"title": "Column Description",
"description": "A description of a column in a table.",
"examples": null,
"is_list": false,
"is_optional": true,
"types": "str",
"location": "structuralMetadata.elements.description"
},
{
"required": true,
"title": "Sensitive",
"description": "A True or False value, indicating if the field is sensitive or not",
"examples": null,
"is_list": false,
"is_optional": false,
"types": "bool",
"location": "structuralMetadata.elements.sensitive"
},
{
"required": true,
"title": "Table Name",
"description": "The name of a table in a dataset.",
"examples": null,
"is_list": true,
"is_optional": false,
"types": "DataElement",
"location": "structuralMetadata.elements"
},
{
"required": false,
"title": "Structural Metadata",
"description": "Structural metadata about tables, columns and values",
"examples": null,
"is_list": true,
"is_optional": true,
"types": "DataClass",
"location": "structuralMetadata"
},
{
"required": false,
"title": "Data Categories",
Expand Down Expand Up @@ -1309,16 +1180,6 @@
},
"location": "tissuesSampleCollection.tissueSampleMetadata.AnatomicalSiteOntologyCode"
},
{
"required": false,
"title": "Tissue Sample Metadata",
"description": "Metadata related to the tissue sample",
"examples": null,
"is_list": false,
"is_optional": true,
"types": "TissueSampleMetadata",
"location": "tissuesSampleCollection.tissueSampleMetadata"
},
{
"required": false,
"title": "Collection Type",
Expand All @@ -1342,16 +1203,6 @@
]
},
"location": "tissuesSampleCollection.collectionType"
},
{
"required": false,
"title": "Tissues Sample Collection",
"description": "Metadata collection for Tissue Samples datasets",
"examples": null,
"is_list": true,
"is_optional": true,
"types": "TissuesSampleCollection",
"location": "tissuesSampleCollection"
}
]
}
Loading

0 comments on commit f8cda20

Please sign in to comment.