Файл Readme

Файл Readme містить інформацію про файл даних. Він допомагає іншим дослідникам та вам самим зрозуміти та повторно використовувати дані в майбутньому. Типовий файл Readme зазвичай зберігається у звичайному текстовому файлі, а не у власних форматах (наприклад, MS Word) для довгострокового доступу.

Нижче наведено деякі загальні аспекти ваших даних, які ви повинні задокументувати, незалежно від вашої дисципліни. 

Загальний огляд

• Назва: назва набору даних або дослідницького проєкту, який його створив.

• Творець: назви та адреси організацій або людей, які створили дані; бажаний формат для особистих імен – прізвище спочатку (наприклад Сміт, Джейн).

• Ідентифікатор: унікальний номер, який використовується для ідентифікації даних, навіть якщо це лише внутрішній номер проєкту.

• Дата: ключові дати, пов’язані з даними, зокрема: дата початку та завершення проєкту; дата випуску; період часу, охоплений даними; та інші дати, пов’язані зі строком служби даних, такі як цикл обслуговування, графік оновлення; бажаний формат РРРР-ММ-ДД або РРРР.ММ.ДД-РРРР.ММ.ДД для діапазону.

• Метод: як були згенеровані дані, перелік використовуваного обладнання та програмного забезпечення (включаючи номери моделі та версії), формули, алгоритми, експериментальні протоколи та інша  інформація, яку можна включити в лабораторний блокнот.

• Обробка: як дані були змінені чи оброблені (наприклад нормалізовані).

• Джерело: посилання на дані, отримані з інших джерел, у тому числі відомості про те, де зберігаються вихідні дані та як до них здійснюється  доступ.

• Фінансувальник: організації чи установи, які фінансували дослідження.

Опис вмісту

• Тема: ключові слова або фрази, що описують тему чи зміст даних.

• Місце: усі відповідні фізичні місця.

• Мова: усі мови, які використовуються в наборі даних.

• Список змінних: усі змінні у файлах даних, де це можливо.

• Список кодів: пояснення кодів або скорочень, які використовуються або в назвах файлів, або в змінних у файлах даних (наприклад «999 вказує на відсутнє значення в даних»).

Технічний опис

• Інвентаризація файлів: усі файли, пов’язані з проєктом, включаючи розширення (наприклад NWPalaceTR.WRL, stone.mov).

• Формати файлів: формати даних, наприклад FITS, SPSS, HTML, JPEG тощо.

• Структура файлу: організація файлу(ів) даних і розташування змінних, де це можливо.

• Версія: унікальна позначка дати/часу та ідентифікатор для кожної версії.

• Контрольна сума: значення, обчислене для кожного файлу, яке можна використовувати для виявлення змін.

• Необхідне програмне забезпечення: назви будь-яких програмних пакетів спеціального призначення, необхідних для створення, перегляду, аналізу або іншого використання даних.

Доступ

• Права: будь-які відомі права інтелектуальної власності, законні права, ліцензії або обмеження на використання даних.

• Інформація про доступ: де та як інші дослідники можуть отримати доступ до ваших даних.

• Інформація про походження похідних чи оцифрованих даних.

Writing READMEs for Research Data

https://data.research.cornell.edu/data-management/sharing/readme/

AUTHOR_DATASET_ReadmeTemplate.txt https://cornell.app.box.com/v/ReadmeTemplate