Skip to main content
Skip table of contents

Codebook v.2

Codebook v.2 is a more advanced and user-friendly system for loading the data map.
August 2025 will be a transition period during which both the new and old versions of the codebook can be used. After that, the codebook v.2 will become the main and only version.
Here is how you can see it in the database settings:

codebook 2-1.png

Key changes

v.1

v.2

Required the full database structure declaration; no incremental loading was allowed

Incremental loading is supported: you can upload a file with only the required columns, and it's no longer necessary to include every variable/value.

We suggest using incremental loading when working with large datasets. This simplifies and speeds up the process of loading and adding new variables and categories.

The declaration of variables and their values occurred on a single codebook tab.

The declaration of variables and their values occurs on different codebook tabs - now we have the Variables tab and the Values tab

The rigid structure required that variables be described above their values; otherwise, the correctness of the import could be compromised.

Since the description of variables and values is on separate tabs, the order is not important. Additionally, the order in which variables are listed does not matter; it will only determine their position in the list after loading.

The column headers have been changed to more intuitive and commonly used terms.
datatile_idname
digitmidpoint
During the transition period, all headers will be supported equally. When loading, if you specify the old version (e.g. datatile_id), it will be correctly processed and automatically replaced with the new one (e.g. name).

Variables Tab

The required columns are type and name.

codebook 2 tabs.png

Each row describes one variable. Supported variable types (type):

  • CAT – Categorical variable (single choice);

  • MC – Multiple choice;

  • MD – Dichotomous;

  • NUM – Numeric;

  • DATE – Date;

  • TXT or TEXT – Text;

  • IGN – Ignored variable.

Except for the label_en column, all values in the codebook are space-tolerant and case-insensitive.

The measure column specifies the subtype or modifier of the variables.

  • For categorical variables, they can be either nominal or ordinal.

  • For numerical variables, it indicates types such as plain, weight, and probabilistic.

Values tab

In the Variables tab, the ref column indicates which values from the Values tab will be associated with the variable. This follows a similar principle to the connection with the DIC variable in Codebook V.1.

The name specified on the Values tab must exactly match the ref used on the Variables tab to ensure correct linkage between variables and their corresponding values.

codebook 2 ref.png

The Values tab structure

The required columns are name and value.

name - the variable reference.
value - category ID.
midpoint - digital equivalent of a certain category.
label_en - category label.
hidden - determines whether a specific category will be visible or hidden upon loading.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.