Quarto. Оформление метаданных

Quarto. Оформление метаданных

1 Общая информация

• Quarto предоставляет богатый набор ключей метаданных YAML для описания деталей научной работы.
• Пример заголовка YAML:

  ---
  title: "Toward a Unified Theory of High-Energy Metaphysics: Silly String Theory"
  date: 2008-02-29
  author:
  ​  - name: Josiah Carberry
      id: jc
      orcid: 0000-0002-1825-0097
      email: josiah@psychoceramics.org
      affiliation:
  ​      - name: Brown University
          city: Providence
          state: RI
          url: www.brown.edu
  abstract: >
    The characteristic theme of the works of Stone is
    the bridge between culture and society. ...
  keywords:
  ​  - Metaphysics
  ​  - String Theory
  license: "CC BY"
  copyright:
    holder: Josiah Carberry
    year: 2008
  citation:
    container-title: Journal of Psychoceramics
    volume: 1
    issue: 1
    doi: 10.5555/12345678
  funding: "The author received no specific funding for this work."
  ---
  

2 Авторы и аффилиации

• Простой способ описания автора:

  ---
  author: Norah Jones
  ---
  

• Ключ author имеет ряд подключей, например ключ affiliation для аффилиации:

  ---
  author:
    name: Norah Jones
    affiliation: Carnegie Mellon University
  ---
  

• Можно описывать несколько авторов:

  ---
  author:
  ​  - name: Norah Jones
      affiliation:
  ​      - Carnegie Mellon University
  ​      - University of Chicago
  ​  - name: Josiah Carberry
      affiliation: Brown University
  ---
  

• Оба эти ключа можно указать с помощью форм единственного (author и affiliation) или множественное число (authors и affiliations).

2.1 Автор

• Доступные ключи для author:
  • email, phone, fax, url (строка) : контактные данные автора;
  • degrees (строка) : ученые звания или профессиональные сертификаты;
  • orcid (строка) : Открытый идентификатор исследователя (ORCID в форме 0000-0000-0000-0000);
  • note (строка) : примечания для автора, например, сведения о вкладе;
  • acknowledgements (строка) : благодарности автора;
  • roles (строка) : роли автора;
  • corresponding (true/false) : автор-корреспондент;
  • equal-contributor (true/false) : равные вклыды;
  • deceased (true/false) : усопший:
  • id (строка) : идентификатор, который будет использоваться для ссылки на этого автора в других полях.
• Например, более полное описание автора может выглядеть так:

  ---
  author:
  ​  - name: Josiah Carberry
      orcid: 0000-0002-1825-0097
      url: https://en.wikipedia.org/wiki/Josiah_S._Carberry
      email: josiah@psychoceramics.org
      corresponding: true
  ---
  

2.1.1 Компоненты имени

• Quarto автоматически анализирует ключ name и его компоненты.
• Если автоматический разбор неверен, вы можете указать компоненты, given, family, dropping-particle, и non-dropping-particle напрямую:

  ---
  author:
  ​  - name:
        given: Charles
        family: Gaulle
        non-dropping-particle: de
  ​  - name:
        given: Ludwig
        family: Beethoven
        dropping-particle: van
  ---
  

2.1.2 Степени

• Вы можете указать степени или ученые звания, используя ключ degrees:

  author:
  ​  - name: Josiah Carberry
      degrees:
  ​      - B.S.
  ​      - PhD
  

2.1.3 Author Roles

• Роль автора может указываться в свободной форме:

  author:
  ​  - name: Josiah Carberry
      roles: "Conceived and designed the study, analysed the results and wrote the manuscript."
  

• Можно использовать таксономию CRediT (см. DCM. Авторская этика):

  author:
  ​  - name: Josiah Carberry
      roles: conceptualization
  

• Можно добавить несколько ролей:

  author:
  ​  - name: Josiah Carberry
      roles: [investigation, data curation]
  

• Можно указать роль вместе со степенью вклада:

  author:
  ​  - name: Josiah Carberry
      roles:
  ​      - investigation: lead
  ​      - data curation: supporting
  

2.2 Аффилиация

• Аффилиацию можно добавить непосредственно к автору:

  ---
  author:
    name: Norah Jones
    affiliation: Carnegie Mellon University
  ---
  

• Можно указать ключ name:

  ---
  author:
    name: Norah Jones
    affiliation:
      name: Carnegie Mellon University
  ---
  

• Дополнительные поля:

  • department (строка);
  • group (строка) : команда или исследовательская группа;
  • address (строка);
  • city (строка);
  • region или state (строка);
  • country (строка);
  • postal-code (строка);
  • url (строка) : сайт организации;
  • isni (число) : 16-значный международный стандартный идентификатор имени (ISNI);
  • ringgold (число) : 4-6-значный идентификатор Ringgold;
  • ror (строка) : Идентификатор реестра исследовательских организаций (ROR), начинающийся с https://ror.org/, за которым следует 9-значный буквенно-цифровой идентификатор.

• Например:

  ---
  author:
    name: Josiah Carberry
    orcid: 0000-0002-1825-0097
    url: https://en.wikipedia.org/wiki/Josiah_S._Carberry
    email: josiah@psychoceramics.org
    corresponding: true
    affiliation:
  ​    - name: Brown University
        department: Psychoceramics
        city: Providence
        state: RI
        country: US
        url: www.brown.edu
        ringgold: 6752
        isni: 0000000419369094
  ---
  

3 Аннотация

• Можно добавить аннотацию с помощью ключа abstract.
• Поскольку аннотации обычно длиннее одной строки и могут содержать разметку, вам нужно будет предоставить её с использованием блочного стиля YAML.
• Поместите символ | на той же строке, что и abstract: и сделайте отступ в два пробела для текста аннотации:

  ---
  abstract: |
    This article evaluates novel approaches to do
    some really important things.
  ---
  

4 Ключевые слова

• Ключевые слова можно добавлять с помощью ключа keywords:

  ---
  keywords:
  ​  - open-source
  ​  - scientific publishing
  ​  - reproducible research
  ---
  

5 Авторские права

• Можно указать авторские права несколькими способами.
• Напрямую в виде строки copyright:

  ---
  copyright: "Copyright Acme, Inc. 2021. All Rights Reserved"
  ---
  

• Используя подключ statement:

  ---
  copyright:
    statement: "Copyright Acme, Inc. 2021. All Rights Reserved"
  ---
  

• Можно указать ключи holder и year:

  ---
  copyright:
    holder: Acme, Inc
    year: 2021
  ---
  

• При указании year можно использовать диапазон (year: 2021 - 2023) или массив (year: [2021, 2022, 2023]).

6 Лицензия

• Чтобы указать лицензию, можно указать строку license:

  ---
  license: "This work is dedicated to the Public Domain"
  ---
  

• Можно указать подключ text:

  ---
  license:
    text: "This work is dedicated to the Public Domain"
  ---
  

• Можно добавить дополнительные сведения, указав подключи type и url:

  ---
  license:
    text: >
      Permission is granted to copy, distribute and/or
      modify this document under the terms of the GNU Free
      Documentation License, Version 1.3 or any later version
      published by the Free Software Foundation; with no
      Invariant Sections, no Front-Cover Texts, and no
      Back-Cover Texts. A copy of the license is included in
      the section entitled "GNU Free Documentation License"
    type: open-access
    url: https://www.gnu.org/licenses/fdl-1.3-standalone.html
  ---
  

• Если вы выбираете лицензию Creative Commons (см. Лицензии Creative Commons), вы можете просто указать аббревиатуру:

  ---
  license: "CC BY"
  ---
  

7 Цитирование

• Ключ citation позволяет указать дополнительные метаданные, которые используются для создания ссылки на документ.

8 Финансирование

• Ключ funding может напрямую задаваться строкой:

  ---
  funding: "The author(s) received no specific funding for this work."
  ---
  

• Можно задать подключ statement:

  ---
  funding:
    statement: "The author(s) received no specific funding for this work."
  ---
  

• Ключ funding также может принимать подключи source, recipient и investigator.

• recipient и investigator могут принимать строку или ссылку на автора или аффилиацию, используя ref:

  ---
  author:
  ​  - name: Norah Jones
      id: nj
  funding:
  ​  - source: "NIH (Grant #: 1-R01-MH99999-01A1)"
      investigator:
  ​      - ref: nj
  ---