Skip to main content

Codebook Template

This page is for anyone who is providing data or codebooks to the Tech and Data Management Core. The Tech and Data Management core publishes EAS data dictionaries on Airtable with an accompanying unified expository codebook that is comprehensive to all data streams for any given data release. Due to this format, we have a few standards to keep in mind for each codebook and dictionary provided to us to facilitate processing.

Templates

Codebook Formatting Instructions​

Codebook format can and should vary to accommodate the needs of varying fields, but the following are the minimally required standards a codebook given to us to be processed should include.

  • A “General Summary of Instrument” section that gives a short, non-technical (2-3 sentence) overview of the purpose of the codebook/instrument. The purpose of this section is to provide codebook readers who do not specialize in the specific domain a general sense of the content.
  • Please include expository text via word, and variable-level dictionaries in Excel.
  • At least one associated paper for the codebook/instrument

Data Dictionary Formatting Instructions​

Dictionary format can and should vary to accomodate the needs of varying fields. The following are minimally required standards a data dictionary given to us to be processed should include.

  • Variables should be run through R package janitor::clean_names() in order to provide standarized variable names.
  • Provide all variables in their own row in the data dictionary
  • Fill in columns A-E in the data dictionary template - feel free to leave notes or add columns as needed. We understand that different fields produce data differently

Submitting Data Dictionaries & Codebooks​

Please email completed data dictionaries and codebooks to Dr. Nelson Roque and Sarah Logan.