Приклад метаданих JSON
Цей приклад показує, як елементи профілю метаданих основного набору даних можуть бути представлені у структурованому записі JSON. Він ілюструє використання об'єктів, масивів, ідентифікаторів, контрольованих значень та зв'язків між набором даних та іншими результатами дослідження.
Використовуйте цей приклад як відправну точку для підготовки машинозчитуваних метаданих, обміну записами між системами або розробки автоматизованих робочих процесів з дослідницькими даними.
Інформація про ресурс
Тип ресурсу
Приклад заповнених метаданих
Цільові користувачі
Дослідники, куратори даних, розробники та відповідальні за дані
Рекомендоване використання
Обмін метаданими, автоматизовані робочі процеси, FAIR-пакування та системна інтеграція
Стан
Ілюстративний приклад Центру компетенцій
Завантажте приклад метаданих JSON
Завантажте завершений приклад, щоб ознайомитися зі структурою, або скористайтеся порожнім шаблоном як відправною точкою для власного запису метаданих.
Що представляє цей приклад?
У цьому прикладі метадані про набір даних представлені як ієрархія структурованих полів. Загальна інформація про набір даних записується на верхньому рівні, тоді як повторювані або складні сутності, такі як автори, посилання на фінансування, дати та пов'язані результати, представлені як масиви вкладених об'єктів.
JSON – це формат представлення, а не стандарт метаданих
JSON визначає, як інформація структурована для машинної обробки. Значення та вимоги до полів визначаються профілем метаданих, репозиторієм або специфікацією обміну, з якою використовується запис JSON.
Що охоплює приклад
Запис групує основні метадані набору даних у чотири машинозчитувані інформаційні області.
Ідентифікація набору даних
Назва, тип ресурсу, опис, версія, рік публікації, постійний ідентифікатор та рекомендоване цитування.
Люди та організації
Творці, учасники, ідентифікатори ORCID, афіліації, ідентифікатори організацій та контактна інформація.
Науковий контекст
Ключові слова, наукова галузь, методи, дати, посилання на фінансування та зв'язки з публікаціями, програмним забезпеченням та проектами.
Доступ та повторне використання
Формати файлів, категорія доступу, ліцензія, інформація про права, статус конфіденційних даних та умови повторного використання.
Повний приклад метаданих JSON
Наведені нижче значення є ілюстративними та мають бути замінені інформацією про фактичний набір даних.
{
"metadata_profile": {
"name": "Профіль метаданих основного набору даних",
"version": "1.0",
"language": "en"
},
"title": "Дані моделювання для структур карбіду кремнію",
"resource_type": "Набір даних",
"description": "Вхідні структури, параметри розрахунку та вихідні дані з обчислювального моделювання карбіду кремнію.",
"version": "1.0",
"publication_year": 2026,
"identifier": {
"identifier": "10.xxxx/example.dataset",
"identifier_type": "DOI"
},
"creators": [
{
"name": "Петренко, Олена",
"given_name": "Олена",
"family_name": "Петренко",
"orcid": "0000-0002-1825-0097",
"affiliations": [
{
"name": "Національна академія наук України",
"ror": "[ідентифікатор ROR]"
}
]
}
],
"contributors": [
{
"name": "Приклад автора",
"contributor_type": "DataCurator",
"orcid": ""
}
],
"contact_point": {
"name": "Контактна особа набору даних",
"email": "data.contact@example.org"
},
"keywords": [
"карбід кремнію",
"обчислювальне матеріалознавство",
"теорія функціоналу густини",
"дані дослідження"
],
"scientific_domains": [
"Матеріалознавство",
"Обчислювальна фізика"
],
"dates": [
{
"date": "2026-04-12",
"date_type": "Створено"
},
{
"date": "2026-07-22",
"date_type": "Оновлено"
}
],
"methods": {
"summary": "Набір даних було створено за допомогою розрахунків електронної структури та подальшої обробки даних.",
"documentation": "README.md",
"provenance_record": "provenance/provenance.json"
},
"funding_references": [
{
"funder_name": "Приклад організації, що фінансує",
"award_title": "Приклад дослідницького проекту",
"award_number": "PROJECT-2026-001"
}
],
"formats": [
"text/csv",
"application/json",
"chemical/x-cif",
"text/plain"
],
"related_identifiers": [
{
"identifier": "10.xxxx/example.article",
"identifier_type": "DOI",
"relation_type": "IsSupplementTo",
"resource_type": "JournalArticle"
},
{
"identifier": "https://example.org/software",
"identifier_type": "URL",
"relation_type": "IsProducedBy",
"resource_type": "Програмне забезпечення"
}
],
"access_rights": "відкрито",
"licence": {
"name": "Creative Commons Attribution 4.0 International",
"identifier": "CC-BY-4.0"
},
"rights_holder": "Творці набору даних",
"sensitive_data": false,
"repository": {
"name": "DataverseUA",
"landing_page": "[Цільова сторінка набору даних сторінка]"
},
"recommended_citation": "Петренко, О. (2026). Дані моделювання для структур карбіду кремнію. DataverseUA. https://doi.org/10.xxxx/example.dataset"
}
Як використовуються елементи JSON
Використовуйте відповідний тип даних JSON для кожного поля та зберігайте однакову структуру в усьому записі.
| Елемент | Призначення | Приклад |
|---|---|---|
| Рядок | Текст, ідентифікатори, контрольовані терміни та дати | "resource_type": "Набір даних" |
| Число | Числові значення, які не слід брати в лапки | "publication_year": 2026 |
| Логічне значення | Умови True або false | "sensitive_data": false |
| Об'єкт | Група пов'язаних іменованих полів | "licence": { ... |
| Масив | Повторювана впорядкована колекція значень або об'єктів | "keywords": [ ... ] |
null |
Явно невідоме або недоступне значення | "size_bytes": null |
Пустий шаблон JSON
Замініть порожні значення та приклади об'єктів метаданими про ваш власний набір даних.
{
"title": "",
"resource_type": "Набір даних",
"description": "",
"version": "",
"publication_year": null,
"identifier": {
"identifier": "",
"identifier_type": ""
},
"creators": [
{
"name": "",
"given_name": "",
"family_name": "",
"orcid": "",
"affiliations": [
{
"name": "",
"ror": ""
}
]
}
],
"contact_point": {
"name": "",
"email": ""
},
"keywords": [],
"scientific_domains": [],
"dates": [],
"methods": {
"резюме": "",
"документація": "",
"запис_походження": ""
},
"референції_фінансування": [],
"формати": [],
"пов'язані_ідентифікатори": [],
"права_доступу": "",
"ліцензія": {
"назва": "",
"ідентифікатор": ""
},
"власник_прав": "",
"сенситивні_дані": хибність,
"репозиторій": {
"назва": "",
"цільова_сторінка": ""
},
"рекомендоване_цитування": ""
Як адаптувати приклад
1. Копіювати
Завантажте та скопіюйте завершений приклад або порожній шаблон.
2. Замінити
Замініть усі ілюстративні значення інформацією про ваш набір даних.
3. Розширення
Додайте повторювані об'єкти та специфічні для домену метадані, де це необхідно.
4. Перевірка
Перевірте синтаксис JSON, структуру полів, ідентифікатори та контрольовані значення.
5. Вирівняти
Перевірте узгодженість із файлом README, маніфестом та записом репозиторію.
Перевірка файлу JSON
Синтаксично коректний файл JSON може бути проаналізований програмним забезпеченням без помилок. Перевірка синтаксису сама по собі не підтверджує, що метадані є повними або науково правильними.
Використання Python
python -m json.tool metadata.json
Використання jq
jq empty metadata.json
Успішна перевірка не призводить до синтаксичних помилок. Назви полів, обов'язкові елементи та контрольовані значення слід перевіряти окремо з відповідним профілем метаданих або схемою JSON.
Поширені помилки JSON
Недійсні лапки
JSON вимагає використання прямих подвійних лапок навколо назв полів та текстових значень.
Кінцеві коми
Не ставте кому після останнього елемента в об'єкті або масиві.
Неправильні типи даних
Числа та логічні значення не слід записувати у вигляді лапок.
Коментарі у файлі
Стандартний JSON не дозволяє пояснювальні коментарі всередині запису.
Важливі примітки
- Зберігайте файли JSON, використовуючи кодування UTF-8.
- Використовуйте подвійні лапки, а не друкарські чи одинарні лапки.
- Використовуйте стабільні та задокументовані назви полів у всіх записах.
- Представляйте повторювані елементи, такі як автори, ключові слова та пов'язані ідентифікатори, як масиви.
- Не використовуйте порожні рядки, якщо поле можна пропустити відповідно до відповідного профілю.
-
Використовуйте
nullлише тоді, коли значення явно невідоме, а не як заміну для кожного необов'язкового поля. -
Використовуйте стандартні представлення дати, такі як
РРРР-ММ-ДД. - Розділяйте ідентифікатори від їхніх типів ідентифікаторів.
- Не включайте паролі, токени доступу або конфіденційну особисту інформацію.
- Переконайтеся, що значення JSON узгоджуються з метаданими репозиторію, README та маніфестом.
{
"resource_type": "набір даних",
"workflow_stage": "Розрахунок DFT",
"software": {
"name": "Квантовий ЕСПРЕСО",
"version": "7.2",
"modules": ["pw.x", "ph.x"]
},
"material": {
"system": "SiC",
"composition": "SiC",
"structure": "cubic"
},
"calculation": {
"method": "DFT",
"exchange_correlation": "PBE",
"псевдопотенціали": [],
"k_points": "",
"cutoff_energy": ""
},
"outputs": {
"files": [],
"властивості": []
},
"походження": {
"створено_ким": "",
"установа": "",
"дата": "",
"пов'язана_публікація": ""
}
}