Regularly document and describe your data

… to help other researchers understand your data




Metadata are the description and documentation of data.  

They describe the content and context of your data files.  For example, title, date, and author are elements of metadata.

Applying metadata keeps your data organized, provides context and attribution, and prepares data for storage, retrieval, sharing, and interoperability.  (Learn more about metadata here.)


Sample metadata elements

Descriptive elementsAdministrative elementsStructural elements
  • Title 
  • Creator or contact  
  • Subject 
  • Date 
  • Experimental conditions 
  • Methodology
  • Identifier number (like DOI)
  • Version
  • Usage or intellectual property rights 
  • Dictionary or codebook to explain the data variables  
  • Relationship of the data to other datasets or files  
  • Tools and software needed for processing or visualizing the data 
  • Funding and institutional requirements for sharing, confidentiality, etc.
  • File formats 
  • File names 
 
For more metadata element examples, check these guides by MIT Libraries and CDL


How to apply metadata - three options

  • At the very least, save metadata as a "readme.txt" file and store with your data.  This .txt file might reference a published article that describes the data.

  • When you're loading data into an archive or repository(?) for storage, there may be a form that you complete to assign required metadata elements.

    • For example, when you deposit genetic sequence data into GenBank, there are certain metadata elements to use as outlined here.

  • "Markup" the dataset with metadata.

    • This is when you annotate your data with metadata elements.

    • For example:

      • <title>Effect of salt on ice cream production efficiency</title> indicates the title of the data file, and 

      • <temperature>0</temperature> indicates a temperature data point

    • Learn more about a popular type of metadata markup known as XML.  Here is a tutorial on XML.





Follow metadata standards

... to describe your data sufficiently 


Metadata standards outline the requirements and procedures for describing and documenting your data.
  • General metadata standards are outlined in the Metadata Reference Guide by MIT Libraries

  • Subject-specific metadata standards are available (examples).  Search online for a standard in your field.
Tip
  • Review metadata standards at the beginning of a project.  This can help you record the appropriate details when collecting data.