Мазмұнға өту

Қайталанымдылық · Бастапқы

Template 5: Data dictionary and integrity record

Create this alongside the dataset. A dictionary should explain the data to someone who did not collect them.

3 мин оқу · 2026 ж. 26 қаз.

Бұл бет әлі аударылмаған, сондықтан ағылшын нұсқасын оқып отырсыз.

Негізгі тұжырымдар

  • Adapt the prompts to the actual study.
  • Complete every statement from verified records.
  • Follow the target journal and institutional requirements.
Мазмұны

Create this alongside the dataset. A dictionary should explain the data to someone who did not collect them.

Create this alongside the dataset. A dictionary should explain the data to someone who did not collect them.

Dataset identity

Dataset name and version: [Name; version]

Purpose: [Question the data address]

One row represents: [Observation unit]

Independent unit and repeated structure: [Definition and identifiers]

Source and acquisition dates: [Origin and period]

Access and licence: [Permitted use and sharing]

Responsible contact: [Appropriate project contact]

Variable definitions

Variable Meaning Type Unit or categories Missing rule Derivation or validation
[name] [Definition] [Numeric, text, date or category] [Units or allowed values] [Meaning of blank or code] [Calculation and acceptable range]

Completed teaching example

Variable Meaning Type Unit or categories Missing rule Derivation or validation
layout_id Constructed case identifier Text 01 to 12 Not allowed Unique per wide table row
error_A_mm Controller A teaching value Numeric Millimetres Blank means absent Nonnegative synthetic value
error_B_mm Controller B teaching value Numeric Millimetres Blank means absent Nonnegative synthetic value
reduction_mm Paired reduction Numeric Millimetres Absent if either input absent A minus B

These entries describe the supplied teaching dataset. A real dataset needs the actual measurement definition and provenance.

Integrity log

Duplicate rule: [How duplicates are identified and resolved]

Unit consistency: [Checks and conversions]

Range checks: [Impossible values versus unusual but possible values]

Corrections: [Original value, corrected value, evidence, date and responsible person]

Exclusions: [Criterion and link to the decision record]

Identifier protection: [Location and access rules for any identity key]

Release checks: [Removal of restricted fields, documentation and version confirmation]

Tutorial: prevent ambiguity before analysis

Read Article 6. A variable name should not be the only explanation of a column. Document its unit, coding, timing, permitted values and missing value rules. Distinguish a missing observation from a valid zero and from a measurement that falls below an instrument's detection limit.

Hypothetical data dictionary entry: completion_time_s means elapsed seconds from task start to verified completion. A separate task_status field distinguishes completed, timed out and device failure. A timed out task does not receive a made up completion time of zero. The protocol specifies the maximum observation period and the analysis explains how incomplete tasks contribute to the findings.

Structure check: Keep an identifier for every level of dependence that matters, such as participant, school, device, batch or site. If the working file has one row per trial, document how many trials belong to each independent unit and how trial level measurements become the reported outcome. Preserve the original observations when generating summaries.

Completion check: Ask a colleague to interpret five rows without verbal guidance. Any uncertainty about units, category meanings, timing or missingness indicates a field the dictionary needs. Include a version date so later changes to the coding do not silently alter the meaning of older analyses.