ReadMe See

ReadMe a file is an informative text file often attached to research and software development projects, file folders or other digital resources (including datasets)to provide clear and useful information to users or developers. ReadMe dathelps users to quickly understand what a project is about and how to work with it.

ReadMe file for the data set

ReadMe It is also advisable to prepare a file for datasets that are preserved in the long term, either deposited in a research data repository or archived in another way (e.g. in university or institute systems).

ReadMe This file contains contextual information about the dataset and aims to ensure that the data can be interpreted correctly both by the author in the long term, including after the research project has finished, and by other users who have been granted access to the dataset.

Where sector-specific standards and requirements exist ReadMe for the preparation of the ReadMe file, these are to be preferred over the ReadMe file content.

• In cases where a dataset consists of multiple, contextually closely related files, it is acceptable to create a single ReadMe a file to describe the dataset. In other cases, a separate file can be created for each dataset ReadMe Data

• If the dataset described contains information that could be useful for an international audience, it is recommended ReadMe the ReadMe file be in English

• ReadMe the file name must include information that:

• • Allows it to be identified as ReadMe and distinguish it from other deposited files – the name should include "ReadMe", "readme" or "read-me" or similar text

• • Indicate unambiguously which of the attached files ReadMe is relevant

• ReadMe must be plain text (.txt) or markdown (.md) format file – proprietary formats such as, MS Word so that any user can open the file without problems

• The formatting of the text should be such that the information is clear and easy to understand – do not write all the information in one paragraph, but separate sections, leaving blank lines between them

• ReadMe must be used in the text UTF-8 encoding, as this ensures a universal and consistent representation of characters across languages and platforms

• If the deposited dataset has multiple ReadMe files, then they must follow a common style and terminology

• Generally accepted naming conventions and notations in the field of the particular science must be followed

• ReadMe complements, but in no way replaces, the metadata, which must be entered as detailed and accurate as possible in the process of depositing the dataset

• ReadMe It is advisable to include contact details in the file so that interested parties can contact the dataset creators if they have any questions, thus facilitating potential collaboration

Recommended ReadMe ReadMe content

General information

1. Brief description of the study and the objectives to be achieved

2. Brief description of the deposited data and their structure

3. File format(s)

4. If the dataset consists of several interlinked files, the nature of the association needs to be described

5. Name, surname, name of the scientific institution represented, ORCID and email:

   • Principal Investigator (or person responsible for data collection)

   • For co-authors

   • Contact person (in case of questions)

6. Date or date range of data collection

7. Geographical location of data origin

8. Date of creation (file version)

9. Date of modification or addition to the file and nature of the changes made (version history of the file)

10. Keywords describing the nature of the data

11. Language(s) used

Metadata on data collection and processing methods

1. Description of the method(s), may include a link to a resource describing the procedure for data collection, processing and quality control

2. Specific settings of measuring instruments during experiments

3. Instrument calibration data

4. Description of the data quality control procedure

5. Coding or designations in the data used to highlight low quality/questionable measurements, outliers (uncharacteristic values) and missing values where such data are included in the dataset

6. Persons involved in sampling, data processing, analysis

Specific data information

1. Transcript of abbreviations and abbreviations used in the dataset, transcript and explanation of column headings for tabular data

2. Units

3. Transcript of the flag used to identify missing data (e.g. NA; -999)

Access rights / sharing

1. The licence to use the data and other restrictions on working with the dataset

2. Links to publications where the dataset is cited or used

If some documentation (e.g. codebook or detailed metadata) already contains some of the information recommended here, ReadMe file, only the most relevant (supplementary information) can be included.

I ReadMe is created and regularly updated at the beginning of the project, it is easier to prepare the final version and avoid errors that can occur if all the information is only collected at the end of the project.

ReadMe file templates are available here to describe the dataset:

• Download ReadMe files