Difference between revisions of "Summary Tables"
(→Summary tables) |
(→The Study schema) |
||
(33 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | <p style="color:blue; text-align:right"><small>'''''Last updated: 20/09/2022'''''</small></p> | ||
− | |||
These two tables, one for the study schema and the second for the Data Object schema, provide a quick summary of the data points in the schemas. They should be read in conjunction with the detailed schema description. | These two tables, one for the study schema and the second for the Data Object schema, provide a quick summary of the data points in the schemas. They should be read in conjunction with the detailed schema description. | ||
<br/> | <br/> | ||
− | + | === The Study schema === | |
{| class="wikitable" style="width: 85%;" | {| class="wikitable" style="width: 85%;" | ||
|- | |- | ||
Line 12: | Line 12: | ||
|- style="vertical-align:top; background-color:white" | |- style="vertical-align:top; background-color:white" | ||
− | | '''A.1 Display Title'''<span style="color:red;font-size:150%;font-weight:bold"> </span><br/>''{display title, language code<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> }''<br/><br/><br/><br/><br/><br/>'''A.8 Study Type'''<span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span><br/><br/>'''A.9 Study Status'''<span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span> ''' | + | | '''A.1 Display Title'''<span style="color:red;font-size:150%;font-weight:bold"> </span><br/>''{display title, language code<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> }''<br/><br/><br/><br/><br/><br/>'''A.8 Study Type'''<span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span><br/><br/>'''A.9 Study Status'''<span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span> '''<br/><br/><br/>A.14 Linked Data Objects'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/> ''{object identifiers}''<br/> '''<br/>A.15 Provenance String'''<br/> |
|| '''A.2 Study Identifiers''' <span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{identifier type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , Identifier value, source organisation, date, url link}''<br/><br/> | || '''A.2 Study Identifiers''' <span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{identifier type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , Identifier value, source organisation, date, url link}''<br/><br/> | ||
− | '''A4. Brief Description' | + | '''A4. Brief Description'''<br/><br/> |
− | + | '''A.6 Study Features'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{feature type <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , feature value <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>}''<br/> | |
− | '''A.6 Study Features'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{feature type <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , feature value <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>}'' | + | '''A.7 Study Topics'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{topic type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , mesh coded?, mesh code <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>, mesh value, original controlled terminology (CT)<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>, CT code <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>, original value}''<br/> |
− | '''A.7 Study Topics'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{topic type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , mesh coded?, | + | '''A.19 Study Contributors'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{contribution type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>, name type, person details OR organisation }''<br/>For person details and organisation fields see C.2 below<br/> |
+ | '''A.16 Study Countries'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{country geonames id <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> ,country}''<br/> '''A.18 Study Start Time'''<br/>''{month, year}'' <br/><br/> | ||
|| '''A3. Study Titles'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{title text, title type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , language code<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , comments}'' | || '''A3. Study Titles'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{title text, title type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , language code<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , comments}'' | ||
− | <br/> | + | <br/><br/> |
− | '''A5. Data Sharing Statement''' | + | '''A5. Data Sharing Statement''' |
− | + | <br/><br/> | |
− | '''A10. Study Enrolment | + | '''A10. Study Enrolment''' |
<br/><br/> | <br/><br/> | ||
'''A11. Study Gender Eligibility''' | '''A11. Study Gender Eligibility''' | ||
Line 32: | Line 33: | ||
<br/><br/> | <br/><br/> | ||
'''A13. Inter-study relationships'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/> | '''A13. Inter-study relationships'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/> | ||
− | ''{relationship type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , target study}'' | + | ''{relationship type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , target study}''<br/><br/> |
+ | '''A.17 Study Sites'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{facility, city geonames id <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>, city, country geonames id <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>, country, status <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>}''<br/><br/> | ||
|} | |} | ||
<span style="color:red;font-size:150%;font-weight:bold"> *</span> May be repeated <span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span> Categorised value | <span style="color:red;font-size:150%;font-weight:bold"> *</span> May be repeated <span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span> Categorised value | ||
− | |||
<br/> | <br/> | ||
− | + | ||
+ | === The Data Object schema === | ||
{| class="wikitable" style="width: 85%;" | {| class="wikitable" style="width: 85%;" | ||
Line 55: | Line 57: | ||
| style="color:darkblue;font-weight:bold" colspan="3"| C. Creators and Contributors | | style="color:darkblue;font-weight:bold" colspan="3"| C. Creators and Contributors | ||
|- style="vertical-align:top; background-color:white" | |- style="vertical-align:top; background-color:white" | ||
− | | '''C.1 Creators'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{name type, person details OR organisation }''<br/> <br/> | + | | '''C.1 Creators'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{name type, person details OR organisation}''<br/> <br/> |
− | || <span style="font-size:150%"> </span> <br/> | + | Used mostly for the authors of journal articles - most other objects do not have named creators. |
− | || '''C.2 Contributors'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{contribution type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , name type, person details OR organisation }''<br/><br/>For most data objects contributors will be the contributors to the associated study or studies. | + | || <span style="font-size:150%"> </span> <br/>'''''person details''' = given name, family name, full name, ORCID identifier, affiliation string, affiliation organisation (id, name, ROR id) <br/>'''organisation''' = organisation default name, MDR id and ROR id, if applicable'' |
− | + | || '''C.2 Contributors'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{contribution type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , name type, person details OR organisation }''<br/><br/>For most data objects contributors will be the contributors to the associated study or studies. | |
|- style="vertical-align:top; background-color:lightblue" | |- style="vertical-align:top; background-color:lightblue" | ||
Line 70: | Line 72: | ||
|'''E.1 Class'''<span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span><br/><br/>'''E.2 Type'''<span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span><br/> | |'''E.1 Class'''<span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span><br/><br/>'''E.2 Type'''<span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span><br/> | ||
|| '''E.3 Record key type''' (datasets only)<span style="font-size:150%"> </span> <br/>''{type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , text description}''<br/><br/>'''E.4 De-identification level''' (datasets only)<br/>''{type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , specific actions, text description}''<br/><br/> | || '''E.3 Record key type''' (datasets only)<span style="font-size:150%"> </span> <br/>''{type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , text description}''<br/><br/>'''E.4 De-identification level''' (datasets only)<br/>''{type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , specific actions, text description}''<br/><br/> | ||
− | '''E.5 Associated consent''' (datasets only)<br/>''{type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , specific restrictions, text description}''<br/><br/>'''E.6 Description'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{description type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , label, description text, language code<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> | + | '''E.5 Associated consent''' (datasets only)<br/>''{type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , specific restrictions, text description}''<br/><br/>'''E.6 Description'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{description type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , label, description text, language code<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>}''<br/><br/> '''E.7 EOSC Category'''<span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span><br/><br/> |
− | '''E.8 Language'''<span style="color:blue;font-size:150%;font-weight:bold"> ⦁ | + | '''E.8 Language'''<span style="color:blue;font-size:150%;font-weight:bold"> ⦁</span><br/><br/>'''E.9 Inter-object relationships'''<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{ relationship type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , target object}''<br/><br/> |
− | || '''E.10 Topics''' (of data object)<span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{topic type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , mesh coded?, | + | || '''E.10 Topics''' (of data object) <span style="color:red;font-size:150%;font-weight:bold"> *</span><br/>''{topic type<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span> , mesh coded?, mesh code <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>, mesh value, original controlled terminology (CT)<span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>, CT code <span style="color:blue;font-style:normal;font-weight:bold"> ⦁</span>, original value}'' |
For most data objects topics should be the study topics.<br/>Journal articles will normally have their own listed topics | For most data objects topics should be the study topics.<br/>Journal articles will normally have their own listed topics | ||
Latest revision as of 10:08, 11 November 2022
Last updated: 20/09/2022
These two tables, one for the study schema and the second for the Data Object schema, provide a quick summary of the data points in the schemas. They should be read in conjunction with the detailed schema description.
The Study schema
Mandatory | Recommended | Optional |
---|---|---|
A. The Source Study | ||
A.1 Display Title {display title, language code ⦁ } A.8 Study Type ⦁ A.9 Study Status ⦁ A.14 Linked Data Objects * {object identifiers} A.15 Provenance String |
A.2 Study Identifiers * {identifier type ⦁ , Identifier value, source organisation, date, url link} A4. Brief Description |
A3. Study Titles * {title text, title type ⦁ , language code ⦁ , comments}
|
* May be repeated ⦁ Categorised value
The Data Object schema
Mandatory | Recommended | Optional |
---|---|---|
B. Data Object Identifiers | ||
B.1 DOI B.2 Display Title B.6 Linked Studies * {study identifiers} B.7 Provenance String |
B.3 Version | B.4 Object Identifiers * {Identifier type ⦁ , Identifier value, source organisation, application date} B.5 Object Titles *
|
C. Creators and Contributors | ||
C.1 Creators * {name type, person details OR organisation} Used mostly for the authors of journal articles - most other objects do not have named creators. |
person details = given name, family name, full name, ORCID identifier, affiliation string, affiliation organisation (id, name, ROR id) organisation = organisation default name, MDR id and ROR id, if applicable |
C.2 Contributors * {contribution type ⦁ , name type, person details OR organisation } For most data objects contributors will be the contributors to the associated study or studies. |
D. Object Dates | ||
D.1 Publication Year | D.2 Dates * {date type ⦁ , Is range, date as string, start year, start month, start day, end year, end month, end day, comments} | |
E. Object Attributes and Descriptors | ||
E.1 Class ⦁ E.2 Type ⦁ |
E.3 Record key type (datasets only) {type ⦁ , text description} E.4 De-identification level (datasets only) {type ⦁ , specific actions, text description} E.5 Associated consent (datasets only) |
E.10 Topics (of data object) * {topic type ⦁ , mesh coded?, mesh code ⦁, mesh value, original controlled terminology (CT) ⦁, CT code ⦁, original value} For most data objects topics should be the study topics. |
F. Object Location and Access Details | ||
F.1 Managing Organisation F.2 Access Type ⦁ |
(F3 is mandatory if access is non-public) |
F.5 Rights {name, rights uri, comments} |
* May be repeated ⦁ Categorised value