Skip to Main Content
QUL logo

README Guide and Template

Support for Research Data Management

Alexandra Cooper
Data Services Coordinator

Meghan Goodchild
Research Data Management Librarian

RDM.library@queensu.ca

README Template

This ReadMe.txt file was generated on YYYY-MM-DD by NAME

## This is a template, and you are free to modify it. Remove any sections or items that are not applicable to your dataset, and add additional information not currently represented in the template that is needed to correctly interpret or reuse your data. 

## PLEASE NOTE: Help text is preceded by ## and should be deleted before saving this file.

--------------------
GENERAL INFORMATION
--------------------

1. Title of Dataset: 

2. Author Information
    A. Principal Investigator Contact Information
        Name: 
        Institution: 
        Address: 
        Email: 

    B. Associate or Co-investigator Contact Information
        Name: 
        Institution: 
        Address: 
        Email: 

    C. Alternate Contact Information
        Name: 
        Institution: 
        Address: 
        Email: 

3.    Keywords used to describe the data topic

4.    Language information

5.    Information about funding sources that supported the collection of the data


-----------------------------------
SHARING/ACCESS INFORMATION
-----------------------------------

1. Licenses/restrictions placed on the data: ##default license - CC-BY (can use datasets with attribution)

2. Recommended citation for the data:


-------------------------
DATA & FILE OVERVIEW
-------------------------

1. File List: 
##list all files (or folders, as appropriate for dataset organization) contained in the dataset, with a brief description

2. Folder strucuture and/or Relationship between files, if important: 

3. Date that the file was created ##Format - YYYY-MM-DD

3. Information about related data collected but that is not in the described dataset: 

---------------------------
METHODOLOGICAL INFORMATION
---------------------------
1. Description of methods used for collection/generation of data: 
##Include links or references to publications or other documentation containing experimental design or protocols used in data collection>

2. Description of methods for data processing: 
##describe how the submitted data were generated from the raw or collected data

3.    Any software or instrument-specific information needed to understand or interpret the data, including software and hardware version numbers ##include full name and version of software, and any necessary packages or libraries needed to run scripts

4.    Standards and calibration information, if appropriate: 

5.    Describe any quality-assurance procedures performed on the data: 

6.    Definitions of codes or symbols used:

7.    People involved with sample collection, processing, analysis and/or submission: 

-------------------------------------------
DATA-SPECIFIC INFORMATION FOR: [FILENAME]
-------------------------------------------
## Repeat this section for each folder or file in the dataset, as appropriate. Recurring items may also be explained in a common initial section.  

<repeat this section for each dataset, folder or file, as appropriate>

1.    Count of number of variables, and number of cases or rows:

2. Variable List: 

## Provide details on each variable in the file. Include the variable name as it appears in the data file; a description of the variable including the full name, explanation of what the variable represents, and units of measure, if applicable; if value labels (codes) has been used, list the value labels with a description of what each label (code) represents; and any additional notes required to understand the nature of the variable or the content found in the variable.

Name: ## Variable name.
Description: ## Explanation of variable including units of measurement, if applicable.
Value labels: ## Define value labels, if applicable.
Notes: ## Enter any other information required to understand the nature of the variable or the content found in the variable, if applicable.

## Example 1. 
## Name: SoilT10
## Description: Soil temperature measured at a soil depth of 10 centimetres, Degrees Celsius.
## Value labels:
    ##   -6999 = Sensor over range
        ##   -9999 = Missing value/No data
## Notes: Soil temperature was measured using a Campbell Scientific CS230 SDI-12 Temperature Profiler. The sensor stopped working at time 13:43 and was rebooted at 14:02.

4. Definiations for codes or symbols used to record missing data: 

5. SPecialized formats or other abreviations used:


## Acknowledgements. This README file template is adapted from the following documents:

- University of Guelph. T_UG_readmeTemplate. Available at: https://doi.org/10.5683/SP2/CPHFGA

- Cornell University. Guide to writing "readme" style metadata. Available at: https://data.research.cornell.edu/content/readme#bestpractices