============================================================================================================ START readme ============================================================================================================ This file focuses more on the details of the data package. For 'administrative' metadata on this data, please view the metadata file within the parent folder of this data package (where this readme file is also found). ============================================================================================================ ## General ============================================================================================================ + Author(s): [names of data and readme creators; delete this explanation line] + Project: [name of the project; delete this explanation line] + Contact: [contact email / point for questions regarding the data and readme; delete this explanation line] ============================================================================================================ ## Title ============================================================================================================ [your title here; delete this explanation and example. Often used title format example: "Data underlying the publication [article title]" + DOI] ============================================================================================================ ## Methods ============================================================================================================ # Introduction [your introduction / abstract / description here; delete this explanation line] # Measurements and data collection [your measurement and data collection explanations here; delete this explanation line] ============================================================================================================ ## FolderStructure ============================================================================================================ [Example structure representation (delete this explanation and example): If you're presenting only individual files without any folder structure or sub-folders, please use the following sentence without quotation marks: "There is only one parent directory present containing all files." If you have a folder with many underlying folders, it is convenient to generate a file that lists the entire folder structure. The following steps only work on Windows / does not work in zip files. - Go to your file explorer - Open the parent folder - In the address bar, type and press enter afterwards: powershell - A blue screen pops up. Continue in that screen. - Type and press enter afterwards: Get-ChildItem | tree > foldertree.txt - there is now a file in your folder [foldertree.txt] You can also manually show your folder structure. Example: - parent_folder --- subfolder ----- sub-subfolder --- subfolder] ============================================================================================================ ## FolderContents ============================================================================================================ [If you're presenting only individual files without any folder structure or sub-folders, please only use the first entry ('- parent_folder/'). Example (delete this explanation and example): - parent_folder/ [content description of folder] --- subfolder/ [content description of subfolder] ----- sub-subfolder/ [content description of sub-subfolder] --- subfolder/ [content description of subfolder]] ============================================================================================================ ## Software ============================================================================================================ SoftwareRequired: [list you software requirements here; delete this explanation line] OtherSoftwareRequirements: [describe attention points in working with specified software (if any); delete this explanation line] ============================================================================================================ ## FileFormats ============================================================================================================ [list the extension of you files here (file formats); delete this explanation line] ============================================================================================================ ## CodeBook ============================================================================================================ Please view codebook.csv (where this readme file is also found) for documentation of abbreviations, column names, datapoints, etc. The file codebook.csv uses the columns: + index = a number used to distinguish the different entries. + code = the abbreviation, variable / data / column name used. + used = location where the code is used. (filename, foldername, columnname, datapoint, protocol, etc.). + meaning = the literal meaning of the code. (e.g., fully written out abbreviation) + represents = what the code represents in terms of data or usage. (e.g., units of measurements, coding used,more in depth explanation) Note that this file is ';' delimited. To avoid possible confusion and inconsistencies, sentences within cells do not contain reading symbols as comma's or semicolons. When required, separation within sections of a sentence is made possible using the hashtag symbol (#). Example: The sex of an animal is described as "m = male pig (boar) # f = female pig (sow)" where the hashtag separates the element in a sentence. ============================================================================================================ ## Other ============================================================================================================ [describe any other attention points that will help understandability of your data package; delete this explanation] ============================================================================================================ END readme ============================================================================================================