reproducible-research/metadata.yml at main · coderefinery/reproducible-research · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# Master metadata for this lesson.
#
# CITATION.cff and bioschemas.yml are both generated from this file by
# generate_metadata_files.py upon push to main, and publish_to_zenodo.py reads it
# directly too. Edit this file, not the generated ones, it will generate CITATION.cff and bioschemas.yml upcon push to main branch.
#
# All values are quoted deliberately, so they always load as plain
# strings (not YAML dates/numbers) - see version below.


# Text. Base lesson title. " - CodeRefinery lesson" is appended
# automatically when generating CITATION.cff/bioschemas.yml and when
# publishing to Zenodo - do not include it here.
title: "Reproducible research - Preparing code to be usable by you and others in the future"

# Text. Used as CITATION.cff's abstract, bioschemas' description/about,
# and the start of the Zenodo description.
abstract: "The lesson 'Reproducible research' prepares code to be usable by you and others in the future. It covers three aspects of reproducible programs and computations: documenting dependencies, environments, and computational steps in a reproducible way, and touches on containers."

# Text (ISO 8601 date, YYYY-MM-DD), quoted so it isn't parsed as a
# YAML date. Used in CITATION.cff, bioschemas.yml, and the Zenodo
# deposit. Also used as CITATION.cff's date-released, since for this
# lesson the two always match - there's no separate date-released field.
version: "2026-08-04"

# Text. The concept DOI, which stays constant across all versions -
# Zenodo assigns the version-specific DOI itself. Used in bioschemas.yml
# as identifier (https://doi.org/<doi>).
doi: "10.5281/zenodo.16410659"

# Text (URL). The lesson's rendered website. Used as bioschemas' @id/url
# and linked in the Zenodo description.
url: "https://coderefinery.github.io/reproducible-research/"

# Text (SPDX license identifier, e.g. CC-BY-4.0). Converted to a full
# license URL for bioschemas.yml via SPDX_LICENSE_URLS in
# generate_metadata_files.py; passed through as-is to CITATION.cff and
# Zenodo.
license: "CC-BY-4.0"

# Text (URL). Source repository, linked in the Zenodo description and
# included in CITATION.cff.
repository-code: "https://github.com/coderefinery/reproducible-research"

# List of Text. Not used in CITATION.cff. Comma-joined for
# bioschemas.yml's keywords string, and used as Zenodo's keywords list.
keywords:
  - "Reproducibility"
  - "Dependencies"
  - "Environments"
  - "Containers"
  - "Workflow management"

# Text or DefinedTerm per schema.org. bioschemas.yml only. E.g.
# "Beginner", "Intermediate", "Advanced".
educationalLevel: "Beginner"

# Text (BCP47 language tag, e.g. "en-UK"). bioschemas.yml only. Not the
# same format Zenodo's own "language" field would expect (ISO 639-2/3),
# so this isn't reused for the Zenodo deposit.
inLanguage: "en-UK"

# Text. bioschemas.yml only. Learning outcomes / what this lesson
# teaches.
teaches: "Be able to apply a well organized directory structure for a project, Understand that code can have dependencies and know how to document them, Be able to document computational steps and have an idea when it can be useful, Know about use cases for containers"

# URL or CreativeWork per schema.org. bioschemas.yml only. The
# collection/series this lesson belongs to.
isPartOf: "https://coderefinery.org"

# Audience (structured object) per schema.org - NOT plain Text, even
# though it's currently stored and emitted as a bare string. bioschemas.yml
# only.
audience: ""

# Text, DefinedTerm, or URL per schema.org. bioschemas.yml only.
# Prerequisites/prior knowledge needed.
competencyRequired: ""

# Text per schema.org. bioschemas.yml only. Describes accessibility
# features of the material.
accessibilitySummary: ""

# Text or DefinedTerm per schema.org. bioschemas.yml only. E.g.
# "lesson", "exercise", "video".
learningResourceType: "lesson"

# Disabled for now. List of CFF-style entries, same shape as authors
# below: either {name: "Org"} for organizations, or {family-names,
# given-names, orcid (optional)} for people. When enabled: mapped to
# CITATION.cff's contact field, bioschemas.yml's maintainer property,
# and Zenodo's contributors (as ContactPerson).
# maintainers:
# - family-names: "Wittke"
#   given-names: "Samantha"

# List of CFF-style author entries: either {name: "Org"} for
# organizations, or {family-names, given-names, orcid (optional)} for
# people. orcid, if given, must be the full https://orcid.org/... URL -
# publish_to_zenodo.py strips that prefix before sending it to Zenodo.
# Used for CITATION.cff authors, bioschemas.yml's author list
# (mapped to Person/Organization), and Zenodo's creators.
authors:
- name: "CodeRefinery"
- family-names: "Wikfeldt"
  given-names: "Kjartan Thor"
- family-names: "Bast"
  given-names: "Radovan"
- family-names: "Darst"
  given-names: "Richard"
- family-names: "Hellsvik"
  given-names: "Johann"
- family-names: "Wittke"
  given-names: "Samantha"
- family-names: "Jääskeläinen"
  given-names: "Matias"
- family-names: "Glerean"
  given-names: "Enrico"
- family-names: "Vathsavayi"
  given-names: "Sri Harsha"
- family-names: "Wang"
  given-names: "Yonglei"