Describe Your Research Data

Describe and explain all the information that will help you and others to make sense of your data in the future; and to understand the processes you followed to collect, process, and analyse it. Watch this video for an overview of creating explanatory documentation.

Descriptive and explanatory information is created at two levels:

Study level: provides an overview of the research context and design, data collection methods, data preparation and results or findings.

The Massey University Code of Responsible Research Conduct says that, at a minimum, researchers should keep detailed records describing the methods used and the results observed, as well as records of any approvals granted as part of the research process.

Data level: can be embedded in data (e.g. headers in an intervew transcript), or recorded in a structured document. It may include:

  • file names and versions
  • variable descriptions, data types and values
  • location of header columns
  • explanation of codes or classification systems
  • explanations of missing values
  • software or hardware information specific to the creation of a particular dataset.

Guide to study and data level description, including examples

Explanatory Documentation Methods

README files

 A README document is a classic way to record explanatory documentation. A README is a plain text document that is stored alongside your data.

Guide to writing README documents, including examples

Data dictionaries

A data dictionary is a collection of the names, attributes and definitions about data elements that are being used in your study. By including a data dictionary, you ensure a standard use of variables across a cohort of researchers.

Guide to making a data dictionary, including examples

Metadata Standards

Metadata is structured information that describes and enables finding, managing, controlling and preserving other information (i.e. data) over time. Metadata serves the same function as a label. Just like other labels, metadata provides information about an object.

There are two distinct groups of metadata: descriptive and technical.

Descriptive metadata describes the data itself; for example title, author, and date.

Technical metadata is system-generated and describes the means by which the digital object was created e.g. camera type and settings.

Unlike README documentation, metadata complies with a formally agreed set of standards, often tailored to particular types of need or disciplines.

Discipline-specific Metadata

If you are working with large datasets, databases, or data management systems, consult with your School for advice on metadata standards that might be appropriate for your area of research.

Disciplines are also now establishing their own metadata standards. The standards may include content and vocabulary standards. A vocabulary sets out the common language a discipline has agreed to use to refer to concepts of interest to that discipline.

Find out more about vocabularies and research data

The Digital Curation Centre's Disciplinary Metadata page can show you what metadata standards are available for your discipline

Find out more:

Manage Your Research Data Tool Kit

Researcher Development

Contact Us

Contact a Subject Librarian
Your first point of contact in the library for RDM guidance, training opportunities and practical support. Subject librarians also provide personal research help by email, phone, or appointment.

Research Development Team
Data management (funder retention requirements) advice for current and future research projects.

Information Technology Services (ITS)
Data-related services and advice on storage, backup, security, data quality, and metadata identification. Limited software for home installation.

Acknowledgements

These guidelines are informed by information provided under open licenses by other organisations including:

Massey Contact Centre Mon - Fri 8:30am to 4:30pm 0800 MASSEY (+64 6 350 5701) TXT 5222 contact@massey.ac.nz Web chat Staff Alumni News Māori @ Massey
http://itswellington.massey.ac.nz/massey/research/library/library-services/research-services/manage-data/describe.cfm
itswellington.massey.ac.nz
crawl=CC-MAIN-2019-26
45417
application/http; msgtype=response
sha1:ITWK4DBY5KUN4XGDLVAXEU6RR7LAWT2N
<urn:uuid:c1dc1bf2-8c84-4cc2-bb3e-b67724418588>
2019-06-20T11:16:21Z
130.123.10.10
text/html
sha1:7HCOQTW6OK7OZUXCJEAWN7VKPMSHXWK4
<urn:uuid:311d1d82-41e1-443b-9b2b-e7e95356618f>
http://itswellington.massey.ac.nz/massey/research/library/library-services/research-services/manage-data/describe.cfm
response
<urn:uuid:22be6bba-c22e-4f47-8fbf-61a1e655f9d8>
isPartOf: CC-MAIN-2019-26
publisher: Common Crawl
description: Wide crawl of the web for June 2019
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-101-154-155.ec2.internal
software: Apache Nutch 1.15 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.1-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/