Чек-лист попередньої перевірки пакету FAIR
Використовуйте цей чек-лист для перевірки завершеного пакету дослідницьких даних перед його поданням на курування, зберіганням у репозиторії або публікацією.
Чек-лист перевіряє наявність, документування та послідовне описування очікуваних файлів, визначення умов доступу та повторного використання, а також те, що пакет містить достатньо інформації для перевірки, збереження та повторного використання.
Інформація про ресурс
Тип ресурсу
Чек-лист контролю якості пакета даних FAIR
Цільові користувачі
Автори наборів даних, куратори даних, розпорядники даних та депозитори репозиторію
Рекомендоване використання
Остаточний огляд пакета перед куруванням, депонуванням у репозиторії або публікацією
Статус
Рекомендований Чекліст перед поданням Центру компетенцій
Завантажити чек-лист
Використовуйте версію XLSX для запису результатів перевірки, доказів, невирішених проблем, відповідальних осіб та коригувальних дій. Версія DOCX підходить для внутрішньої перевірки та затвердження.
Доступні формати
Що таке пакет даних FAIR?
Пакет даних FAIR – це організована колекція дослідницьких даних, метаданих, документації та допоміжних файлів, підготовлених для збереження, публікації та повторного використання.
Його точний склад залежить від дисципліни та методу дослідження. Пакет може містити необроблені або оброблені дані, скрипти, файли конфігурації, інформацію про програмне середовище, записи про походження, візуалізації та допоміжну документацію.
Чек-лист розглядає пакет в цілому
Окремі файли можуть бути технічно валідними, тоді як повний пакет залишається невідповідним. Таким чином, попередня перевірка порівнює шляхи до файлів, версії, імена, метадані, документацію, умови доступу та зв'язки між усіма компонентами пакета.
Очікувані компоненти пакета
Не кожен пакет вимагає кожного компонента. Вибрані елементи повинні відображати фактичний метод дослідження, типи даних та заплановане повторне використання.
Дані дослідження
Необроблені, оброблені, похідні або кінцеві файли даних разом із структурами, моделями, таблицями, зображеннями або іншими результатами дослідження.
Документація
Файл README, методологічні описи, словники даних, кодові книги, протоколи та інструкції для інтерпретації файлів.
Структуровані записи
Маніфест, метадані набору даних, контрольні суми, записи походження, описи робочих процесів та інформація про програмне середовище.
Інформація про доступ та повторне використання
Ліцензія, заява про права, категорія доступу, ембарго, обмеження, інформація про цитування та контактні дані.
Мінімальний пакет для попередньої перевірки
Як мінімум, надішліть основні файли даних, файл README, файл інвентаризації або маніфесту, чернетку запису метаданих та інформацію про умови доступу та повторного використання.
Додавайте скрипти, файли конфігурації, походження, записи програмного середовища та докази контролю якості, коли вони потрібні для розуміння або відтворення результатів.
Детальний чек-лист попередньої перевірки
Перевірте кожен критерій на відповідність фактичному пакету. Запишіть відповідний файл, поле метаданих, URL-адресу або інші докази у Чеклісту, який можна завантажити.
| Область | Критерій попередньої перевірки | Очікувані докази |
|---|---|---|
| Ідентичність пакета та область застосування | Пакет представляє чітко визначений набір даних або результат дослідження. | Назва, опис та заява про область застосування |
| Версія пакета визначена. | Версія у README та метаданих | |
| Визначено відповідальних авторів та контактну особу. | Автор та контактна особа поля | |
| Вміст відповідає заявленій науковій меті. | README та інвентаризація файлів | |
| Тимчасові, дубліковані та непов'язані файли видалено. | Переглянуто остаточний каталог | |
| Файли та організація | Структура папок чітка та послідовна. | Структура каталогів пакетів |
| Імена файлів є змістовними та відповідають послідовній домовленості. | Фактичні імена файлів | |
| Відносні шляхи використовуються в документації та структурованих записах. | Маніфест, файли метаданих та робочих процесів | |
| Розширення файлів відповідають фактичним форматам файлів. | Перевірка або валідація файлів | |
| Можна розрізнити необроблені, оброблені, похідні та кінцеві файли. | Поля структури папок або ролі файлу | |
| Стиснуті архіви можна відкрити, і вони містять очікувані файли. | Результат валідації архіву | |
| Файли, які потребують спеціального програмного забезпечення, чітко ідентифіковані. | Файл README та інформація про формат | |
| Файл README та документація | Поточний файл README міститься в кореневому каталозі пакета. | README.md або еквівалентний файл |
| Файл README пояснює призначення та вміст пакета. | Розділ огляду | |
| Файл README пояснює структуру каталогів та файлів. | Розділ структури файлів | |
| Методи створення, збору або обробки даних задокументовані. | Розділ методів або супровідний документ | |
| Визначено необхідне програмне забезпечення, інструменти або робочі процеси. | Розділ технічних вимог | |
| Відомі обмеження та проблеми з якістю задокументовані. | Обмеження або якість розділ | |
| Маніфест та цілісність | Включено інвентаризацію маніфесту або структурованих файлів. | manifest.csv, XLSX або JSON |
| Кожен головний файл має запис маніфесту. | Один запис на файл | |
| Шляхи маніфесту точно відповідають шляхам пакета. | Успішне порівняння шляхів | |
| Ролі та описи файлів відповідають README. | Порівняння маніфесту та README | |
| Розміри файлів записані там, де це необхідно. | size_bytes значення |
|
| Контрольні суми згенеровано для основних файлів або файлів збереження. | Поля контрольної суми та алгоритму | |
| Метадані набору даних | Доступний структурований запис метаданих. | Профіль метаданих, JSON або чернетка репозиторію |
| Назва набору даних ідентична в метаданих та документації. | Порівняння метаданих та README | |
| Імена та афіліації авторів переліченіпредставлено послідовно. | Поля автора та афіліації | |
| ORCID та ідентифікатори організації включено, де це можливо. | Поля ORCID та ROR | |
| Опис пояснює зміст, мету та обсяг. | Поле опису | |
| Записуються ключові слова, наукова область, методи та формати. | Відповідні поля метаданих | |
| Визначено пов'язані публікації, програмне забезпечення, проекти та набори даних. | Записи пов'язаних ідентифікаторів | |
| Походження та відтворюваність | Походження можна визначити основні файли. | README, маніфест або запис походження |
| Вхідні, вихідні та похідні файли з'єднані, де це доречно. | Зв'язки або метадані робочого процесу | |
| Скрипти та файли конфігурації, необхідні для повторного використання, включено. | Скрипти та каталоги конфігурації | |
| Назви та версії програмного забезпечення задокументовано. | README або файл середовища | |
| Середовище виконання або залежності записані, де це необхідно. | YAML середовища, файл вимог або посилання на контейнер | |
| Докази контролю якості та конвергенції включено, де це доречно. | Журнали перевірки, таблиці або звіти | |
| Доступ, права та повторне використання | Категорія доступу чітко визначена. | Відкритий, обмежений, заборонений або закритий |
| Обмеження та процедури доступу задокументовані. | Заява про доступ | |
| Персональні, конфіденційні або чутливі дані перевірено. | Задокументоване рішення про перегляд | |
| Власник прав та повноваження на публікацію підтверджено. | Заява про права або внутрішнє схвалення | |
| Вибрано ліцензію або заяву про повторне використання. | Ідентифікатор ліцензії або заява про права | |
| Вибрана ліцензія є узгодженою для всіх файлів та метаданих. | Порівняння README–метаданих–репозиторію | |
| Можна підготувати рекомендоване посилання. | Посилання | |
| Технічна перевірка | Основні файли можна відкрити за допомогою зазначеного програмного забезпечення. | Тест на відкриття файлів |
| Структуровані файли є синтаксично коректними. | Результат перевірки JSON, CSV, XML або YAML | |
| У таблицях використовуються узгоджені роздільники, кодування та структура стовпців. | Перевірка CSV або електронної таблиці | |
| Текстові файли використовують відповідне кодування символів. | UTF-8, де це доречно | |
| Посилання та шляхи, на які посилаються, розв'язуються правильно. | Успішна перевірка посилань та шляхів | |
| Паролі, токени, облікові дані чи небажані конфіденційні файли відсутні. | Перевірка безпеки | |
| Остаточна узгодженість | Імена файлів та шляхи збігаються в README, маніфесті та метаданих. | Перевірка узгодженості між файлами |
| Назва, версія, автори, ліцензія та умови доступу узгоджені. | Перехресне порівняння записів | |
| Усі файли, заявлені в документації, присутні. | Порівняння каталогів та документації | |
| Усі важливі файли пакета заявлені в маніфесті. | Перевірка повноти маніфесту | |
| Фінальну версію пакета схвалено для подання. | Призначено рецензента та дату перегляду |
Як записати результат
Запишіть як статус, так і докази, використані для перевірки кожного критерію.
Так
Критерій виконано, і підтверджуючі докази доступні.
Частково
Критерій виконано, але потрібне виправлення або доповнення.
Ні
Критерій не виконано.
Не застосовується
Критерій не застосовується до цього пакету даних.
Потрібне уточнення
Перш ніж приймати рішення, потрібна консультація спеціаліста.
Як користуватися чек-листом
1. 1. Фіксація версії
Підготуйте чітко ідентифіковану версію пакета для перегляду.
2. Перевірте
Перегляньте файли, документацію та структуровані записи.
3. Порівняйте
Перевірте узгодженість між README, маніфестом, метаданими та фактичним пакетом.
4. Виправте
Вирішіть проблеми з відсутніми файлами, недійсними шляхами, прогалинами метаданих та правами .
5. Затвердити
Запишіть рецензента, дату перевірки та затверджену версію пакета.
Проблеми, які мають блокувати надсилання
Пакет не слід продовжувати надсилання, доки не будуть вирішені наступні критичні проблеми.
Відсутні основні файли
Необхідні файли даних, метаданих або документації відсутні або їх неможливо відкрити.
Невирішені права або конфіденційність
Питання щодо повноважень на публікацію, ліцензування, конфіденційності або персональних даних залишаються незрозумілими.
Суть невідповідностей
Шляхи до файлів, версії, назви, автори або умови доступу конфліктують між записами пакетів.
Контент, що стосується безпеки
Облікові дані, токени, внутрішні секрети або ненавмисна обмежена інформація присутні.
Запишіть перевірку пакета
У заповненому чек-листу має бути зазначено назву та версію пакета, дату перевірки, рецензента, невирішені проблеми, коригувальні дії та остаточне рішення.
Рекомендовані рішення: затверджено, затверджено з незначними виправленнями, потрібне доопрацювання або потрібна консультація спеціаліста.
Важливі примітки
- Застосовуйте чек-лист до фіксованої та чітко визначеної версії пакета. версії.
- Переглядайте фактичні файли, а не покладайтеся лише на README або заяви автора.
- Записуйте докази для кожного важливого рішення.
- Використовуйте відносні шляхи послідовно в маніфесті, метаданих та записах робочого процесу.
- Генеруйте остаточні контрольні суми лише після того, як файли будуть завершені та заморожені для надсилання.
- Перезапускайте попередню перевірку щоразу, коли файли додаються, видаляються, перейменовуються або замінюються.
- Не включайте паролі, ключі API, токени автентифікації або значення конфігурації, що стосуються безпеки.
- Вимоги до депозиту, специфічні для репозиторію, слід перевірити на додаток до цієї загальної перевірки пакета.
- Проходження цієї попередньої перевірки не замінює перевірки репозиторію, дисциплінарної перевірки або офіційної оцінки FAIR.