10:52 a.m.
Dear colleagues,
in our weekly coding group meeting some questions regarding the structure (not the
content!) of the excel submission template came up and we decided that it would be
beneficial if we could all agree on some rules regarding the structure of the template, as
well as a nomenclature that defines how properties should be named.
You might wonder why this is important, but it would enable us (the coding group) to write
more universal code and generally simplify things. Below, I outlined our current
preferences regarding template structure and nomenclature. Of course, none of this is set
in stone yet and should you diagree with anything or want to add something, we will
discuss this at our next TA1/2 meeting. I will also write this into the overview document
under "3.7.2 Submission Template – General Structure & Nomenclature", you
can just add to it there.
1. Relational classes (i.e. "Study", "Subject", ...) are each a single
sheet in the file. The sheet name would be in Camel-case (i.e. "Study",
"ExperimentalProtocol", "LabSample")
2. The properties for each class are each a column in the corresponding sheet. Column
names are in Snake-case (i.e. "access_type", "sample_type",
"species")
3. All relational keys (primary and foreign) follow the same syntax: First the sheet name
in lower case, then an underscore and then "ID", examples:
"subject_ID", "labsample_ID"
Open question: Should the template contain additional information that will guide the user
when filling the template? Additional information could be: A short description of the
property, allowed values / types, can multiple values be entered (and if yes, how to
separate them correctly), is the property required/recommended/optional?
Looking forward to any feedback on this!
Best,
Vera
12:42 p.m.
Excellent! Thank you Vera!
May I suggest, that all abbreviations are kept in lower case when writing in snake-case?
For the metadata development group, we are working on the template, and it is currently
heavily inspired by GHGA. The reason is that we, while working, need at least some degree
of common memory about the different properties.
The developing version of the mode and user template currently lives at Task Area 1 >
Metadata model development and validation > 1_Data model development >
metadata_model.xlsx (https://nextcloud.nfdi4immuno.de/f/18440).
Best,
Ulrik
-----Ursprüngliche Nachricht-----
Von: Vera Bockhorn <Vera.Bockhorn(a)drfz.de>
Gesendet: Freitag, 28. März 2025 10:52
An: TA1/2 NFDI4Immuno (nfdi4immuno-ta1-2(a)lists.nfdi.de)
<nfdi4immuno-ta1-2(a)lists.nfdi.de>
Betreff: [nfdi4immuno-ta1+2] General structure of metadata submission template
Dear colleagues,
in our weekly coding group meeting some questions regarding the structure (not the
content!) of the excel submission template came up and we decided that it would be
beneficial if we could all agree on some rules regarding the structure of the template, as
well as a nomenclature that defines how properties should be named.
You might wonder why this is important, but it would enable us (the coding group) to write
more universal code and generally simplify things. Below, I outlined our current
preferences regarding template structure and nomenclature. Of course, none of this is set
in stone yet and should you diagree with anything or want to add something, we will
discuss this at our next TA1/2 meeting. I will also write this into the overview document
under "3.7.2 Submission Template – General Structure & Nomenclature", you
can just add to it there.
1. Relational classes (i.e. "Study", "Subject", ...) are each a single
sheet in the file. The sheet name would be in Camel-case (i.e. "Study",
"ExperimentalProtocol", "LabSample") 2. The properties for each class
are each a column in the corresponding sheet. Column names are in Snake-case (i.e.
"access_type", "sample_type", "species") 3. All relational
keys (primary and foreign) follow the same syntax: First the sheet name in lower case,
then an underscore and then "ID", examples: "subject_ID",
"labsample_ID"
Open question: Should the template contain additional information that will guide the user
when filling the template? Additional information could be: A short description of the
property, allowed values / types, can multiple values be entered (and if yes, how to
separate them correctly), is the property required/recommended/optional?
Looking forward to any feedback on this!
Best,
Vera
_______________________________________________
NFDI4Immuno - TA1 & TA2 mailing list -- nfdi4immuno-ta1-2(a)lists.nfdi.de To unsubscribe
send an email to nfdi4immuno-ta1-2-leave(a)lists.nfdi.de
_______________________________________________________________
Mitten in der St. Elisabeth Gruppe:
St. Anna Hospital Herne, Marien Hospital Herne – Universitätsklinikum der Ruhr-Universität
Bochum,
Marien Hospital Witten, Rheumazentrum Ruhrgebiet, St. Marien Hospital Eickel,
Medizinische Reha für psychische Gesundheit, St. Elisabeth Stift Herne,
Senioreneinrichtungen Widumer Höfe,
Gästehaus St. Elisabeth, Ambulante Pflege, MVZ Ärzte – Herne | Wanne | Witten,
Lukas Hospiz Herne, St. Elisabeth Hospiz Witten, Bildungszentrum Ruhr, Bildungswerk,
Campus der St. Elisabeth Gruppe, Kinder in der St. Elisabeth Gruppe
_______________________________________________________________
Aufsichtsratsvorsitzender: Dr. Hans Willmes
Geschäftsführung: Dr. Sabine Edlinger, Simone Lauer
Registergericht:
HRB 9735 Amtsgericht Bochum
St.-Nr.: 325/5894/2251
_______________________________________________________________
Wir bitten wegen der aktuellen Virenangriffe um folgende Beachtung:
Das Sicherheitskonzept der St. Elisabeth Gruppe erlaubt momentan keine Zustellung von
.doc
(x) und .xls(x) Dateien! Schicken Sie Dokumente nur in Form von .pdf Dateien oder nehmen
Sie
Kontakt auf, um andere Übertragungsmöglichkeiten abzusprechen.
4:23 p.m.
Thank you very much Vera!
Since you have already shown that it is easily possible to upload a table while leaving
out the first rows, I am very much in favor the template contain additional information
that will guide the user when filling the template.
Best,
Sebastian
________________________________
Von: Stervbo,Ulrik <Ulrik.Stervbo(a)elisabethgruppe.de>
Gesendet: Freitag, 28. März 2025 12:42
An: Vera Bockhorn; TA1/2 NFDI4Immuno (nfdi4immuno-ta1-2(a)lists.nfdi.de)
Betreff: [nfdi4immuno-ta1+2] Re: General structure of metadata submission template
Excellent! Thank you Vera!
May I suggest, that all abbreviations are kept in lower case when writing in snake-case?
For the metadata development group, we are working on the template, and it is currently
heavily inspired by GHGA. The reason is that we, while working, need at least some degree
of common memory about the different properties.
The developing version of the mode and user template currently lives at Task Area 1 >
Metadata model development and validation > 1_Data model development >
metadata_model.xlsx
(https://smex-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2...).
Best,
Ulrik
-----Ursprüngliche Nachricht-----
Von: Vera Bockhorn <Vera.Bockhorn(a)drfz.de>
Gesendet: Freitag, 28. März 2025 10:52
An: TA1/2 NFDI4Immuno (nfdi4immuno-ta1-2(a)lists.nfdi.de)
<nfdi4immuno-ta1-2(a)lists.nfdi.de>
Betreff: [nfdi4immuno-ta1+2] General structure of metadata submission template
Dear colleagues,
in our weekly coding group meeting some questions regarding the structure (not the
content!) of the excel submission template came up and we decided that it would be
beneficial if we could all agree on some rules regarding the structure of the template, as
well as a nomenclature that defines how properties should be named.
You might wonder why this is important, but it would enable us (the coding group) to write
more universal code and generally simplify things. Below, I outlined our current
preferences regarding template structure and nomenclature. Of course, none of this is set
in stone yet and should you diagree with anything or want to add something, we will
discuss this at our next TA1/2 meeting. I will also write this into the overview document
under "3.7.2 Submission Template – General Structure & Nomenclature", you
can just add to it there.
1. Relational classes (i.e. "Study", "Subject", ...) are each a single
sheet in the file. The sheet name would be in Camel-case (i.e. "Study",
"ExperimentalProtocol", "LabSample") 2. The properties for each class
are each a column in the corresponding sheet. Column names are in Snake-case (i.e.
"access_type", "sample_type", "species") 3. All relational
keys (primary and foreign) follow the same syntax: First the sheet name in lower case,
then an underscore and then "ID", examples: "subject_ID",
"labsample_ID"
Open question: Should the template contain additional information that will guide the user
when filling the template? Additional information could be: A short description of the
property, allowed values / types, can multiple values be entered (and if yes, how to
separate them correctly), is the property required/recommended/optional?
Looking forward to any feedback on this!
Best,
Vera
_______________________________________________
NFDI4Immuno - TA1 & TA2 mailing list -- nfdi4immuno-ta1-2(a)lists.nfdi.de To unsubscribe
send an email to nfdi4immuno-ta1-2-leave(a)lists.nfdi.de
_______________________________________________________________
Mitten in der St. Elisabeth Gruppe:
St. Anna Hospital Herne, Marien Hospital Herne – Universitätsklinikum der Ruhr-Universität
Bochum,
Marien Hospital Witten, Rheumazentrum Ruhrgebiet, St. Marien Hospital Eickel,
Medizinische Reha für psychische Gesundheit, St. Elisabeth Stift Herne,
Senioreneinrichtungen Widumer Höfe,
Gästehaus St. Elisabeth, Ambulante Pflege, MVZ Ärzte – Herne | Wanne | Witten,
Lukas Hospiz Herne, St. Elisabeth Hospiz Witten, Bildungszentrum Ruhr, Bildungswerk,
Campus der St. Elisabeth Gruppe, Kinder in der St. Elisabeth Gruppe
_______________________________________________________________
Aufsichtsratsvorsitzender: Dr. Hans Willmes
Geschäftsführung: Dr. Sabine Edlinger, Simone Lauer
Registergericht:
HRB 9735 Amtsgericht Bochum
St.-Nr.: 325/5894/2251
_______________________________________________________________
Wir bitten wegen der aktuellen Virenangriffe um folgende Beachtung:
Das Sicherheitskonzept der St. Elisabeth Gruppe erlaubt momentan keine Zustellung von
.doc
(x) und .xls(x) Dateien! Schicken Sie Dokumente nur in Form von .pdf Dateien oder nehmen
Sie
Kontakt auf, um andere Übertragungsmöglichkeiten abzusprechen.
_______________________________________________
NFDI4Immuno - TA1 & TA2 mailing list -- nfdi4immuno-ta1-2(a)lists.nfdi.de
To unsubscribe send an email to nfdi4immuno-ta1-2-leave(a)lists.nfdi.de
219
days inactive
219
days old
nfdi4immuno-ta1-2@lists.nfdi.de
2 comments
3 participants
participants (3)
-
Sebastian Ferrara -
Stervbo,Ulrik -
Vera Bockhorn