Шаблон маніфесту для пакету даних FAIR

Використовуйте цей шаблон для створення структурованого переліку всіх файлів, що входять до пакету даних FAIR. Маніфест записує імена файлів, розташування, формати, ролі, зв'язки, умови доступу та інформацію про цілісність, допомагаючи користувачам зрозуміти та перевірити пакет.

ChatGPT Image 19 лип. 2026 р., 19_20_15 (2)

Інформація про ресурс

Тип ресурсу

Шаблон інвентаризації файлів

Цільові користувачі

Дослідники, куратори даних, розпорядники даних та менеджери репозиторіїв

Статус

Рекомендований шаблон Центру компетенцій

Завантажуйте шаблон маніфесту

Оберіть формат, який найкраще відповідає вашому робочому процесу. CSV рекомендується як базовий сумісний формат. XLSX зручний для ручної підготовки та перевірки, тоді як JSON підходить для машинозчитуваних пакетів даних та автоматизованих робочих процесів.

Доступні формати

Завантажити CSV Завантажити XLSX Завантажити JSON Переглянути довідковий PDF-файл

Що таке маніфест?

Маніфест — це структурований перелік файлів, що входять до пакета даних. У ньому записується, що собою являє кожен файл, де він розташований, яку роль виконує, як він пов'язаний з іншими файлами та, де це можливо, як можна перевірити його цілісність.

Маніфест доповнює файл README. Файл README пояснює набір даних та надає інструкції для користувачів, тоді як маніфест надає систематичний опис пакета на рівні файлів.

Файл README та маніфест мають різні функції

Файл README пояснює набір даних та надає інструкції для користувачів. Маніфест містить систематичний опис пакета на рівні файлів. пакета.

Що охоплює шаблон

Шаблон упорядковує інформацію на рівні файлів у чотири практичні області документації.

Ідентифікація файлу

Ім'я файлу, відносний шлях, розширення файлу, тип носія, розмір файлу та розташування пакета.

Роль та вміст файлу

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

Зв'язки та походження

Вихідний файл, похідний файл, пов'язаний крок робочого процесу, залежність, зв'язок вхід-вихід та пов'язана документація.

Цілісність та доступ

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

Поле	Призначення	Приклад
`ім'я_файлу`	Ім'я файлу, включаючи його розширення	`results_simulation.csv`
`reltive_path`	Розташування файлу в пакеті	`results/simulation_results.csv`
`file_role`	Функція файлу в пакеті	Оброблені дані
`description`	Короткий опис вмісту файлу	Розраховані значення, що використовуються в остаточному аналізі
`format`	Формат файлу або тип носія	`text/csv`
`size_bytes`	Розмір файлу в байтах	`245760`
`related_to`	Пов'язаний вхідний, вихідний або документаційний файл	`scripts/analyse.py`
`checksum`	Значення, що використовується для перевірки цілісності файлу	`8f14e45f...`
`checksum_algorithm`	Алгоритм, що використовується для генерації контрольної суми	`SHA-256`
`access`	Категорія або обмеження доступу	open
`ліцензія`	Ліцензія, що застосовується до файлу	`CC BY 4.0`

Як користуватися шаблоном

1. Підготовка

Упорядкуйте набір даних та визначте всі дані, скрипти, документацію та файли результатів.

2. Список

Додайте один запис маніфесту для кожного файлу, що входить до пакета.

3. Опишіть

Вкажіть вміст та роль кожного файлу.

4. Зв'яжіть

Запишіть відповідні вхідні-вихідні, залежні та похідні зв'язки.

5. Перевірити

Перевірити шляхи, формати, контрольні суми, ліцензії та умови доступу.

Приклад структури пакета

Маніфест зазвичай слід розміщувати в кореневому каталозі пакета даних.

назва-набору-даних/
│
├── README.md
├── manifest.csv
├── metadata.json
│
├── дані/
│ ├── сирі дані/
│ └── оброблені дані/
│
├── скрипти/
├── конфігурація/
├── документація/
└── результати/

Приклади записів маніфесту

ім'я_файлу, відносний_шлях, роль_файлу, опис, формат, пов'язаний_з, доступ
input.csv, дані/raw/input.csv, сирі_дані, оригінальні вхідні спостереження, текст/csv,, відкрити
clean.py, скрипти/clean.py, скрипт обробки, скрипт, що використовується для очищення вхідних даних, текст/x-python, дані/raw/input.csv, відкрити
cleaned.csv, дані/processed/cleaned.csv, оброблені дані, очищені спостереження, використані для аналізу, текст/csv, скрипти/clean.py, відкрити
README.md, README.md, документація, повна документація набір даних, текст/markdown, відкрити

Важливі примітки

Використовуйте відносні шляхи, а не шляхи до локального комп'ютера, такі як C:\Users\....
Використовуйте один запис для кожного файлу, а не один запис для кожної папки.
Дотримуйтесь імен файлів та шляхів у повній відповідності до фактичного пакета.
Описуйте ролі файлів послідовно, наприклад: необроблені дані, оброблені дані, скрипт, конфігурація, метадані, документація та результат.
Не включайте паролі, облікові дані доступу або конфіденційну інформацію в маніфесті.
Оновлювати маніфест щоразу, коли файли додаються, видаляються, перейменовуються або замінюються.
Генерувати контрольні суми лише після підготовки остаточних версій файлів файлів.

Мінімальний маніфест

Як мінімум, маніфест повинен містити один запис для кожного файлу та визначати його назву, відносний шлях, роль, короткий опис та формат.

Рекомендовані мінімальні поля: ім'я_файлу, відносний_шлях, роль_файлу, опис та формат.