README Files

README Documents

README files are created for a variety of reasons:

1) to document changes to files or file names within a folder;

2) to explain file naming conventions, practices, etc. "in general" for future reference; and

3) to specifically accompany files/data being deposited in a repository.

It is best practice to create a README document for each dataset regardless of whether it is being deposited in a repository because the document might become necessary at a later point.

A good data practice is to store a readme.txt with each distinct dataset that explains your file naming convention along with any abbreviations or codes you have used. Write your README document as a plain text file, and avoid proprietary formats, such as Microsoft Word, whenever possible. A README template is below, with recommendations for information you may want to include.

Note: If you deposit your final datasets in a data repository, the repository may ask you to provide a README document with additional details about your datasets, such as methodological information or sharing/access information. Creating a README document at the beginning of your research process, and updating it consistently throughout your research, will help you to compile a final README document when your data is ready for deposit.

README Template (Recommended minimum content is in bold.)

  1. Title of dataset

  2. Name/institution/contact information for:

    1. Principal Investigator (or person responsible for collecting the data)

  3. File name structure:

    1. Structure: Provide the template you are using for your filenames.

    2. Attributes: Describe the attributes used to name the files.

    3. Codes: Provide a complete list of any codes/abbreviations used.

    4. Provide examples of above items.

  4. File formats: Provide a list of all file formats present in this dataset.

  5. Column headings for tabular data: For any tabular data, list and define column headings, including:

    1. Units of measurement

    2. Data formats, such as YYYYMMDD

    3. Calculations

  6. Versioning: Establish a procedure for documenting changes in files. One option is to create a changelog in this ReadMe document, where every step that will change the output files is listed.

 

Example README Document

  1. Dataset title: Raw Images for Experiment A, Smith Lab

  2. Principal Investigator: John Smith, PI, 555-555-5555, jsmith@hms.harvard.edu

  3. File name structure:

          Structure:

          ExperimentName_InstrumentID_CaptureDateTime_ImageID.tif

          The base file name is composed of the name of the experiment, the ID number of the instrument used, the date and time that the image was captured, and the unique identifier of the image.

          Attributes:

          ExperimentName = Name of the experiment.

          Instrument ID = Five-digit code assigned to the lab instrument. See the Codes section for a list of instruments and their ID numbers.

          CaptureDateTime = Date and time at which the image was captured, in YYYYMMDDThhmm format.

          Image ID = Three-digit unique identifier for image, such as 001, 002, 003.

          Codes:

          [List of instruments and IDs]

          Examples:

          daf2-age1_14052_20150412T0515_005.tif

      4. File formats: tif

      5. Versioning: All changes to this dataset will be documented in a changelog in this ReadMe document.

 

Last Updated: 2017-01-17