Instantly share code, notes, and snippets.

Embed
What would you like to do?
---
title: "Codebook template"
author: "Your name here"
date: "The date here"
output:
html_document:
keep_md: yes
---
## Project Description
Short description of the project
##Study design and data processing
###Collection of the raw data
Description of how the data was collected.
###Notes on the original (raw) data
Some additional notes (if avaialble, otherwise you can leave this section out).
##Creating the tidy datafile
###Guide to create the tidy data file
Description on how to create the tidy data file (1. download the data, ...)/
###Cleaning of the data
Short, high-level description of what the cleaning script does. [link to the readme document that describes the code in greater detail]()
##Description of the variables in the tiny_data.txt file
General description of the file including:
- Dimensions of the dataset
- Summary of the data
- Variables present in the dataset
(you can easily use Rcode for this, just load the dataset and provide the information directly form the tidy data file)
###Variable 1 (repeat this section for all variables in the dataset)
Short description of what the variable describes.
Some information on the variable including:
- Class of the variable
- Unique values/levels of the variable
- Unit of measurement (if no unit of measurement list this as well)
- In case names follow some schema, describe how entries were constructed (for example time-body-gyroscope-z has 4 levels of descriptors. Describe these 4 levels).
(you can easily use Rcode for this, just load the dataset and provide the information directly form the tidy data file)
####Notes on variable 1:
If available, some additional notes on the variable not covered elsewehere. If no notes are present leave this section out.
##Sources
Sources you used if any, otherise leave out.
##Annex
If you used any code in the codebook that had the echo=FALSE attribute post this here (make sure you set the results parameter to 'hide' as you do not want the results to show again)
@rlugojr

This comment has been minimized.

rlugojr commented Nov 25, 2016

Awesome! Thanks for the guidance. Best format for the codebook I've seen so far and much better than investing a month that I don't have in order to understand memisc! Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment