Data Documentation

Introduction
--------------------------------------------------------------------------
Title:
Authors:
 - % Author 1
 - % Author 2
 - % Author 3

Technical POC:
Data Access POC:

Funding Statement:

Data Description:
% Insert a brief "abstract" like description of the data here

Organization:
% Give an overview of the directory organization and contents

--------------------------------------------------------------------------
Data Type
--------------------------------------------------------------------------
-----------------
FILES
-----------------

Filename format:

File description:

File format:
% Describe the file format here. For columnar data list and explain column names. 

Important Notes:
% Add any important notes about issues, quirks, missing data, messiness, etc for this file type here.


-----------------
METHODS
-----------------
Setup:


Steps:
	1. 
	2.
	3.
	4.
	5. 

Important Notes:

In addition to the information in the general template, add these specifics.

Setup
----------------------------
For machines/sensors:
  - Machine types
  - Relevant machine settings
  - Process parameters in a meta file (ideally with ontology)

Consider which variables are critical to reproducibility:
  - Location
  - Time
  - Demographics
  - Materials
  - Machines
  - Sensors
  - Build architectures

Steps
----------------------------
  - Data collection
  - Data post-processing
  - Pointer to software release that captures any steps

• Clearly specify the original data source
  • Make sure the data release is in accordance with the original data license
• List processing steps
  • Include code generated to process data
• Detail the methods for collecting, compiling, and correlating any additional data outside the original dataset

The primary decision regarding a simulated data set is whether you are publishing only the generated data, only the data generating code, or both.

Use the previous sections’ suggestions based on this decision to complete your README.

Say you are given the following list of column names:

R
Th
Data
Rs
RsA
RsB

Do you know what they stand for? Rs for example could be “Right side”, “Remote sensing”, “Row space”, “Rapid Start”, “Reed-Sternberg” – the list is endless!

The file these come from is named PtAu_20deg_sheet_resistance.csv. We can deduce that at least one of these columns refers to sheet resistance, but which one?

R = Radius, polar coordinate
Th = Theta, polar coordinate
Data = Sheet resistance
Rs = Sheet resistance, duplicate of Data
RsA = Sheet resistance in single mode configuration
RsB = Sheet resistance in dual mode configuration

How could we make these better? First we can remove Rs given that it’s a duplicate. After that, we can rename the rest of the variables to make them clear:

position_radius
position_theta
sheet_resistance
sheet_resistance_single_mode
sheet_resistance_double_mode

This is Clarence. Clarence is a 101 year old tortoise brought from the Galapagos islands to the United States in 1927 as part of an effort to save his species. In 2001, Clarence moved from the Los Angeles Zoo to the Moorpark College Teaching Zoo. In preparation for this move, the Los Angeles Zoo informed the Moorpark College Zoo that they should prepare an enclosure that was big enough for a tortoise that weighs 250.

250… what? The Los Angeles Zoo meant kilograms; the Moorpark College Zoo assumed pounds. Clarence immediately escaped from his new enclosure. (Don’t worry – they found him later!)

The moral of the story? Include your units! Using the variable names from before, we can adjust them to:

position_radius_microns
position_theta_deg
sheet_resistance_ohm/square
sheet_resistance_single_mode_ohm/square
sheet_resistance_double_mode_ohm/square