Codebook
The codebook defines the charting form. It lists every variable charted for each included source of evidence, as PRISMA-ScR item 11 requires. The form is a draft and will be revised after piloting on a sample of sources.
The form has two tables, both CSV files in data/raw/. The sources table has one row per included source. The factors table has one row per factor that a source reports, so a source with five factors has five rows there. The tables are linked by source_id. Closed variables take only the values listed below, in lowercase. This page and 03-charting both read the variables from codebook.yml, so a change is made there once.
Sources
included_sources_raw.csv. One row per included source of evidence.
| Variable | Definition | Allowed values | Required |
|---|---|---|---|
source_id |
Identifier of the source of evidence. Reports of the same study share one source_id. |
Free text | yes |
record_id |
Identifier of the primary report in deduplicated_records.csv. |
Free text | yes |
tier |
Context tier from the protocol. | 1, 2 |
yes |
field |
Field of research the source concerns. | health, other, cross-disciplinary |
yes |
field_detail |
Specific field or subfield, such as genomics or archaeology. | Free text | no |
source_type |
Type of source. | empirical, review, policy-guidance, opinion, other |
yes |
peer_reviewed |
Whether the source was peer reviewed. | yes, no |
no |
data_origin |
Origin of the data the source concerns. research means collected for research. routine-reused means collected for operational or care purposes and reused for research. |
research, routine-reused, mixed, unclear |
no |
region |
Country or region of the data, institutions, or participants. | Free text | no |
notes |
Anything that affects interpretation. | Free text | no |
Factors
included_factors_raw.csv. One row per factor that a source reports. A source that reports five factors has five rows, each with its own type, category, and level.
| Variable | Definition | Allowed values | Required |
|---|---|---|---|
source_id |
The source that reports the factor. It must appear in included_sources_raw.csv. |
Free text | yes |
factor |
The specific factor, in the source’s words or a close paraphrase. | Free text | yes |
factor_type |
Kind of factor. | barrier, facilitator, governance-mechanism |
yes |
factor_category |
Initial categories from van Panhuis et al. (2014), revised during synthesis. Left empty until the factor is coded. | technical, motivational, economic, political, legal, ethical, other |
no |
level |
Level at which the factor operates. system covers national, sectoral, and international levels. When a source reports the same factor at two levels, enter one row for each. |
individual, institutional, system |
no |
notes |
Anything that affects interpretation. | Free text | no |
03-charting.ipynb stops with an error when a charted value is not allowed, a required cell is empty, or a source_id or record_id does not match the other files.