Як підготувати метадані набору даних
Метадані набору даних описують, що містить набір даних, чому і як він був створений, хто за нього відповідає, як до нього можна отримати доступ і за яких умов його можна використовувати повторно.
У цих рекомендаціях пояснюється, як збирати, структурувати та переглядати метадані набору даних перед депонуванням у сховище, публікацією, каталогізацією або експортом у машинозчитуваний формат.
Інформація про ресурс
Тип ресурсу
Покрокове керівництво з підготовки метаданих
Цільові користувачі
Дослідники, автори наборів даних, куратори даних та розпорядники даних
Рекомендоване використання
Перед депонуванням у репозиторії, публікацією набору даних, каталогізацією або оцінкою FAIR
Пов'язані результати
Повний та внутрішньо узгоджений запис метаданих набору даних
Що таке метадані набору даних?
Метадані набору даних – це структурована інформація, яка використовується для ідентифікації, опису, виявлення, інтерпретації, цитування, доступу та повторного використання дослідницького набору даних.
Їх можна вводити у форму репозиторію, зберігати у файлі JSON, XML, CSV або електронній таблиці, надавати доступ через API або інтерфейс збору даних та індексувати зовнішніми дослідницькими інформаційними системами.
Метадані – це не те саме, що README
Запис метаданих надає структуровану та стандартизовану інформацію для репозиторіїв та машин. Файл README надає повніше пояснення набору даних, структури файлу, методів та інструкцій повторного використання, які можна прочитати людиною. Ці два елементи повинні доповнювати одне одного.
Перш ніж почати
Визначте набір даних та зберіть інформацію, необхідну для його опису, перш ніж заповнювати окремі поля метаданих.
Визначте об'єкт
Визначте, які файли, версії та результати дослідження належать до описуваного набору даних.
Визначте відповідальних
Підтвердьте авторів, учасників, контактну особу та відповідальну установу.
Виберіть місце призначення
Визначте репозиторій, каталог або інформаційну систему, в якій будуть використані метадані.
Обмеження щодо рецензування
Визначте, чи впливають правові, етичні, договірні або конфіденційні умови на опис або публікацію.
Робочий процес підготовки метаданих
Підготуйте запис у послідовності, яка переходить від ідентифікації набору даних до доступу, повторного використання та остаточної перевірки.
1. Визначення
Визначте обсяг, версію та наукову мету набору даних.
2. Визначте
Запишіть назву, творців, організації, дати та ідентифікатори.
3. Опишіть
Поясніть зміст, методи, тему, охоплення та формати файлів.
4. Підключення
Пов'яжіть набір даних з публікаціями, програмним забезпеченням, проектами та пов'язаними наборами даних.
5. Перевірка
Перевірте повноту, узгодженість, синтаксис та відповідність файлам.
Основні групи метаданих
Повний запис набору даних зазвичай повинен охоплювати такі групи інформації.
| Група метаданих | Основна інформація | Мета |
|---|---|---|
| Ідентифікація | Назва, ідентифікатор, версія, тип ресурсу та рік публікації | Унікально ідентифікує набір даних та відрізняє його від інших результатів |
| Відповідальність | Творці, автори, контактна особа та організації | Підтримує атрибуцію, відповідальність та комунікацію |
| Опис | Опис, мета, методи, вміст та обмеження | Дозволяє користувачам розуміти набір даних, не відкриваючи кожен файл |
| Виявлення | Тематика, ключові слова, мова та охоплення | Покращує індексацію, класифікацію та пошук |
| Технічна інформація | Формати, програмне забезпечення, інструменти, змінні, одиниці та рівень обробки | Підтримує інтерпретацію та технічне повторне використання |
| Доступ | Відкриті, обмежені, заборонені або закриті умови доступу | Пояснює, чи можна і як файли можна отримати |
| Права та повторне використання | Інформація про ліцензію, власника прав, атрибуцію та цитування | Визначає дозволені форми повторного використання |
| Зв'язки | Публікації, програмне забезпечення, проекти, версії та пов'язані набори даних | Зв'язує набір даних з його ширшим дослідницьким контекстом |
| Походження | Джерела, робочі процеси, етапи обробки та зв'язки походження | Пояснює, як набір даних був створений або перетворений |
Крок 1 — Визначення набору даних
Перш ніж писати метадані, визначте цифровий об'єкт, який буде опубліковано або каталогізовано. Запис метаданих повинен описувати один зв'язний набір даних, а не невизначену колекцію файлів проекту файлів.
Питання для вирішення
- Який науковий об'єкт або результат представляє набір даних?
- Які файли належать до набору даних?
- Чи включені необроблені, оброблені та похідні дані?
- Це новий набір даних, версія чи частина більшої колекції?
- Які файли будуть загальнодоступними, а які будуть обмеженого доступу?
- Хто відповідає за затвердження остаточного запису?
Крок 2. Створіть чітку назву
Назва повинна визначати сам набір даних, його основну тему та, де це доречно, метод, матеріал, місцезнаходження, інструмент або період, що охоплюється.
Менш інформативно
Експериментальні результати
Дані моделювання
Вимірювання для статті
Більш інформативно
Рентгенівські дифракційні вимірювання зразків оксиду алюмінію за кімнатної температури
DFT-розрахунки структурних та електронних властивостей 3C-SiC
Дані геномного секвенування для досліджуваних бактеріальних ізолятів
Крок 3 — Автори записів та організації
Перелічіть людей, які несуть основну відповідальність за створення набору даних. Запишіть інших учасників як авторів та вкажіть їхні ролі, якщо система метаданих це підтримує.
Рекомендована практика
- Використовуйте одну узгоджену форму імені кожної особи.
- Зберігайте порядок, у якому їх вказували автори.
- Додавайте ідентифікатори ORCID, де це можливо.
- Записуйте повну інформацію про інституційну приналежність.
- Додавайте постійні ідентифікатори організацій, де це підтримується.
- Визначте контактну особу, яка може відповісти після публікації.
- Розрізняйте авторів від кураторів, керівників та технічних співробітників.
Крок 4 — Напишіть опис
Опис має дозволити іншому досліднику зрозуміти, що містить набір даних, чому він був створений і як його можна використовувати.
Корисний опис зазвичай відповідає на п'ять запитань
- Що містить набір даних?
- Чому його було створено?
- Як дані збиралися, обчислювалися або оброблялися?
- Яку наукову, просторову, часову чи матеріальну сферу він охоплює?
- Які обмеження чи умови повинні знати користувачі?
Приклад структури опису
Цей набір даних містить [основні типи даних], отримані під час [експерименту, спостереження, опитування або розрахунок]. Дані були згенеровані за допомогою [методу, інструменту, програмного забезпечення або робочого процесу] для досягнення [наукової мети].
Пакет включає [основні групи файлів] та охоплює [матеріал, місцезнаходження, популяцію, період або діапазон параметрів]. Процедури обробки та контролю якості описані у файлі README та супровідній документації.
Крок 5 — Додайте теми та ключові слова
Виберіть терміни, що описують наукову дисципліну, об'єкт дослідження, метод, тип даних та головні змінні. Використовуйте контрольовану термінологію, де існує відповідний словник.
Вибір ключових слів
- Використовуйте конкретні, а не надто загальні терміни.
- Вкажіть основний об'єкт дослідження або матеріал.
- Вкажіть метод, інструмент або обчислювальний підхід.
- Вкажіть відповідний тип даних.
- Уникайте незрозумілих скорочень.
- Не повторюйте ту саму концепцію в кількох дещо різних формах.
- Запишіть назву словника або URI, коли використовуються контрольовані терміни.
Крок 6 — Опис технічних характеристик
Запишіть достатньо технічної інформації, щоб користувачі могли відкривати, інтерпретувати та обробляти файли.
| Технічний елемент | Що записувати |
|---|---|
| Формати файлів | Формати або типи носіїв, що використовуються основними файлами |
| Програмне забезпечення | Назви програмного забезпечення, версії та необхідні розширення |
| Інструменти | Назва, модель та відповідна конфігурація інструменту |
| Змінні | Назви змінних, визначення, коди та дійсні значення |
| Одиниці | Одиниці вимірювання та умовні позначення одиниць |
| Рівень обробки | Необроблені, очищені, оброблені, похідні, змодельовані або кінцеві дані |
| Середовище | Залежності, операційне середовище або посилання на контейнер, де це необхідно |
Крок 7 — Визначення умов доступу та повторного використання
Статус доступу та ліцензія описують різні аспекти набору даних і їх слід записувати окремо.
Статус доступу
Пояснює, чи є файли відкритими, обмеженими, забороненими або закритими, і як можна отримати доступ.
Заява про ліцензію або права
Пояснює, що користувачі можуть робити з набором даних після того, як вони отримали доступ.
Перевірте перед призначенням ліцензії
Підтвердьте власника прав, повноваження на публікацію, сторонній контент, зобов'язання щодо конфіденційності та будь-які етичні або договірні обмеження.
Крок 8 — Зв'язування пов'язаних результатів дослідження
Зв'яжіть набір даних з дослідницьким контекстом, у якому він був створений. Використовуйте постійні ідентифікатори, коли вони доступні.
Публікації
Статті, звіти, тези, доповіді на конференціях та інформаційні документи
Програмне забезпечення
Вихідний код, скрипти, моделі, пакети та обчислювальні інструменти
Проекти
Дослідницькі проекти, гранти, програми та інфраструктури
Інші набори даних
Вихідні набори даних, похідні набори даних, версії та колекції компонентів
Крок 9 — Запис походження
Походження пояснює, звідки походять дані та які дії, програмне забезпечення, інструменти чи робочі процеси призвели до створення депонованих файлів.
Запис походження, коли набір даних містить
- дані, отримані з іншого набору даних;
- кілька етапів обробки або обчислення;
- вхідні, проміжні та вихідні файли;
- програмно-залежні перетворення;
- результати моделювання або обчислювального робочого процесу;
- рішення про ручне очищення, виключення або виправлення;
- об'єднані дані з кількох джерел.
Крок 10 — Перевірка метаданих
Перегляньте як вміст запису, так і його відповідність фактичному пакету даних.
| Область перевірки | Запитання |
|---|---|
| Повнота | Чи всі обов'язкові та відповідні поля присутні? |
| Точність | Чи описують значення фактичний набір даних? |
| Узгодженість | Чи відповідають назва, автори, версія, ліцензія та умови доступу README та запису репозиторію? |
| Ідентифікатори | Чи є ORCID, DOI, ROR та пов'язані ідентифікатори дійсними та правильно призначеними? |
| Контрольовані значення | Чи терміни, ролі, типи ресурсів та зв'язки закодовані послідовно? |
| Синтаксис | Чи є дати, мовні коди, URL-адреси, JSON та інші структуровані значення дійсними? |
| Конфіденційність | Чи публічні метадані уникають розкриття захищеної інформації? |
| Машинночитабельність | Чи можна експортувати запис без втрати структури та зв'язків? |
Поширені проблеми з метаданими
Загальні описи
Опис повторює назву, але не пояснює вміст, метод або обсяг.
Невідповідні назви
Імена авторів або їхня приналежність відрізняються між метаданими, публікаціями та документацією.
Відсутні зв'язки
Публікації, програмне забезпечення, проекти або вихідні набори даних згадуються лише у вільному тексті.
Плутанина з ліцензіями
Відкритий доступ, доступність файлів та дозволене повторне використання розглядаються як одне й те саме поняття.
Незрозуміла термінологія
Скорочення, змінні, одиниці вимірювання та локальні коди не визначені.
Вигадані ідентифікатори
Заповнювачі або ідентифікатори, створені вручну, представлені як призначені постійні ідентифікатори.
Підготовка лише для репозиторію
Метадані вводяться безпосередньо у форму без збереження структурованого локального запису.
Невідповідність пакетів
Метадані відносяться до файлів, версій або умов доступу, які відрізняються від депонованого пакета.
Рекомендований метод роботи
Спочатку підготуйте метадані у структурованому локальному шаблоні. Перегляньте запис з авторами набору даних, а потім перенесіть або зіставте затверджені значення з формою репозиторію або машинозчитуваним форматом.
Зберігайте затверджений файл метаданих у пакеті даних FAIR, щоб запис репозиторію, README, маніфест та майбутні версії можна було перевірити за тим самим джерелом.
Важливі примітки
- Описуйте набір даних, а не дослідницький проект в цілому.
- Використовуйте фактичні обов'язкові поля репозиторію на додаток до основного профілю метаданих.
- Не створюйте фіктивні ідентифікатори DOI, ORCID, ROR або грантів.
- Використовуйте постійні ідентифікатори лише після перевірки того, що вони ведуть до правильного об'єкта.
- Зберігайте статус доступу та інформацію про ліцензію окремо.
- Не розголошуйте особисту, конфіденційну або чутливу до безпеки інформацію в публічних метаданих.
- Записуйте зв'язки як структуровані ідентифікатори, а не лише згадуйте їх в описі.
- Оновлюйте метадані щоразу, коли змінюється версія набору даних, файли, автори, умови доступу або ліцензія.
- Перевіряйте експортований або опублікований запис метаданих, а не лише локальний робочий файл.