Skip to content

Commit

Permalink
updates to form annotations hdr v3
Browse files Browse the repository at this point in the history
  • Loading branch information
@BSnelling
BSnelling committed Jun 20, 2024
1 parent 0c893e9 commit ef28d41
Show file tree
Hide file tree
Showing 5 changed files with 215 additions and 180 deletions.
24 changes: 12 additions & 12 deletions docs/HDRUK/3.0.0.form.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1092,7 +1092,7 @@
},
{
"required": true,
"title": null,
"title": "Persistent identifier of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand All @@ -1108,7 +1108,7 @@
},
{
"required": true,
"title": null,
"title": "Title of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand All @@ -1124,7 +1124,7 @@
},
{
"required": true,
"title": null,
"title": "Url of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand All @@ -1140,7 +1140,7 @@
},
{
"required": true,
"title": null,
"title": "Persistent identifier of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand All @@ -1156,7 +1156,7 @@
},
{
"required": true,
"title": null,
"title": "Title of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand All @@ -1172,7 +1172,7 @@
},
{
"required": true,
"title": null,
"title": "Url of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand All @@ -1188,7 +1188,7 @@
},
{
"required": true,
"title": null,
"title": "Persistent identifier of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand All @@ -1204,7 +1204,7 @@
},
{
"required": true,
"title": null,
"title": "Title of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand All @@ -1220,7 +1220,7 @@
},
{
"required": true,
"title": null,
"title": "Url of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand All @@ -1236,7 +1236,7 @@
},
{
"required": true,
"title": null,
"title": "Persistent identifier of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand All @@ -1252,7 +1252,7 @@
},
{
"required": true,
"title": null,
"title": "Title of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand All @@ -1268,7 +1268,7 @@
},
{
"required": true,
"title": null,
"title": "Url of a dataset",
"description": null,
"guidance": "",
"examples": null,
Expand Down
125 changes: 67 additions & 58 deletions docs/HDRUK/3.0.0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -790,9 +790,9 @@ If applicable, please provide DOIs or links to datasets from which data in this

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-----------------------------------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| Persistent identifier of a dataset | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |



Expand All @@ -801,9 +801,9 @@ None

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-------------------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| Title of a dataset | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |



Expand All @@ -812,9 +812,9 @@ None

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:----------------------------------------------------------------------------------------------------|
| | | False | True | True | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-----------------|:-----------|:----------|:--------------|:-----------|:----------------------------------------------------------------------------------------------------|
| Url of a dataset | | False | True | True | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |



Expand All @@ -832,9 +832,9 @@ This relationship indicates that the dataset is a component or subset of a broad

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-----------------------------------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| Persistent identifier of a dataset | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |



Expand All @@ -843,9 +843,9 @@ None

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-------------------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| Title of a dataset | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |



Expand All @@ -854,9 +854,9 @@ None

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:----------------------------------------------------------------------------------------------------|
| | | False | True | True | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-----------------|:-----------|:----------|:--------------|:-----------|:----------------------------------------------------------------------------------------------------|
| Url of a dataset | | False | True | True | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |



Expand All @@ -874,9 +874,9 @@ If applicable, please provide the DOI of other datasets that have previously bee

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-----------------------------------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| Persistent identifier of a dataset | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |



Expand All @@ -885,9 +885,9 @@ None

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-------------------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| Title of a dataset | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |



Expand All @@ -896,9 +896,9 @@ None

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:----------------------------------------------------------------------------------------------------|
| | | False | True | True | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-----------------|:-----------|:----------|:--------------|:-----------|:----------------------------------------------------------------------------------------------------|
| Url of a dataset | | False | True | True | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |



Expand All @@ -916,9 +916,9 @@ Datasets that are similar to each other in some way, collect similar patients, r

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-----------------------------------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| Persistent identifier of a dataset | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |



Expand All @@ -927,9 +927,9 @@ None

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-------------------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| Title of a dataset | | False | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]", 'null'] |



Expand All @@ -938,9 +938,9 @@ None

None

| title | guidance | is_list | is_optional | required | type |
|:--------|:-----------|:----------|:--------------|:-----------|:----------------------------------------------------------------------------------------------------|
| | | False | True | True | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
| title | guidance | is_list | is_optional | required | type |
|:-----------------|:-----------|:----------|:--------------|:-----------|:----------------------------------------------------------------------------------------------------|
| Url of a dataset | | False | True | True | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |



Expand Down Expand Up @@ -1079,7 +1079,16 @@ Descriptions of all tables and data elements that can be included in the dataset



### name
### tables

Tables in the dataset






#### name

The name of a table in a dataset.

Expand All @@ -1090,7 +1099,7 @@ The name of a table in a dataset.



### description
#### description

A description of a table in a dataset.

Expand All @@ -1101,18 +1110,7 @@ A description of a table in a dataset.



### syntheticDataWebLink

Links to locations of information and or raw downloads of synthetic data associated with this dataset.

| title | guidance | is_list | is_optional | required | type |
|:-------------------------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| Synthetic data web links | | True | True | False | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]"] |




### columns
#### columns

A list of columns contained within a table in a dataset.

Expand All @@ -1121,7 +1119,7 @@ A list of columns contained within a table in a dataset.



#### name
##### name

The name of a column in a table.

Expand All @@ -1132,7 +1130,7 @@ The name of a column in a table.



#### dataType
##### dataType

The data type of values in the column.

Expand All @@ -1143,7 +1141,7 @@ The data type of values in the column.



#### description
##### description

A description of a column in a table.

Expand All @@ -1154,7 +1152,7 @@ A description of a column in a table.



#### sensitive
##### sensitive

A True or False value, indicating if the field is sensitive or not.

Expand All @@ -1165,7 +1163,7 @@ A True or False value, indicating if the field is sensitive or not.



#### values
##### values

Values in a dataset.

Expand All @@ -1174,7 +1172,7 @@ Values in a dataset.



##### name
###### name

Unique value in a column.

Expand All @@ -1185,7 +1183,7 @@ Unique value in a column.



##### description
###### description

A description of a unique value in a column.

Expand All @@ -1196,7 +1194,7 @@ A description of a unique value in a column.



##### frequency
###### frequency

The frequency of occurrance of a value in a column.

Expand All @@ -1206,3 +1204,14 @@ The frequency of occurrance of a value in a column.




### syntheticDataWebLink

Links to locations of information and or raw downloads of synthetic data associated with this dataset.

| title | guidance | is_list | is_optional | required | type |
|:-------------------------|:-----------|:----------|:--------------|:-----------|:--------------------------------------------------------------------------------------------|
| Synthetic data web links | | True | True | False | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]"] |



Loading

0 comments on commit ef28d41

Please sign in to comment.