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