Dataset readme template

– beginning of readme –

• Date Published: [e.g. January 7, 2023 and/or 20230107]

• Dataset Title: [e.g. Dataset for Analysis of Scare Particles Embedded in 35mm Prints of American Horror Films]

• Dataset Creators: [everyone involved in the creation and analysis of the data; e.g. Joe Bob Briggs, Annie Wilkes, Roger Corman]

• Dataset Contact: [main contact or PI’s e-mail address; include secondary contact information in case PI is unavailable]

• Funding: [use this to list all funders and awards used to support your dataset; e.g. NNX14AE72G (NASA), DE-SC0013991 (DOE), & 80NSSC17K0323 (NASA Earth and Space Science Fellowship, NESSF)]

• Key Points: [very brief overview of your dataset and what it is attempting to relay to the user]

• Research Overview: [an overview of your research]

• Methodology: [your methodology and any links to related protocols, codebases, or complementary data]

• File Types Used: [a list of all file types included in your dataset, e.g. .pdf, .txt, .csv, .sb7dat, HEIC]

• Software Required to View or Render Data: [use this to list any software another researcher would need in order to view, render, or otherwise interact with your dataset, e.g. SAS; Imaris; numPy]

• Folder Structure: [use this space to give an overview of your file structure or any information a research would need in order to understand the dataset’s organization, e.g.

ScareParticlesDataSet_01.zip
├── ScaryData1/
│ └── ScareCode_01/
├── ScaryResults/
│ ├── ParticleFigure01.tif
│ └── ParticleFigure02.tif
└── ScareModels/

For file hierarchies, you can include a text file, or copy and paste into this file a directory listing, which you can do in a few ways (see below in “Helpful Links”). But ultimately we encourage you to use this section to relay the general logic of your dataset’s folder hierarchy.]

• File naming convention: [use this as a space to explain your file naming convention, e.g. “ExperimentName_InstrumentName_CaptureTime_ImageID.tif”, or “ScareParticicleIrradiation_ScareOTron_20230137_SOS666”)

• Data Dictionary: [use this space to enumerate the variables, attributes, or fields included in your data (tabular or otherwise), e.g. “FilmFrame, IrradiationResult, HorrorFilm, ScareQuotient, ScaryNotes”; if possible, also include valid values and brief definitions of each field]

• Use and Access: [use this to note the license under which you wish to publish your dataset and how users can access it ; e.g. “this dataset is made available under a Creative Commons Public Domain license (CC0 1.0) and can be accessed via URRR hosted by University of Rochester at rochster.figshare.com”]

— end of readme —

General Tips

• For folder structure and file naming, you do not need to subscribe to a specific standard – just be consistent and explain the logic.
• For use and access, avoid asking users to contact the research team for access.
• Remember: this document is intended to be read by users to satisfy most questions they might have on how the data was collected, processed, analyzed, licensed, and presented.
• Avoid waiting until the last minute to create a readme: as soon as you know how to answer one part of a readme, add it to the document.
• While a plain text (.txt) is the Library’s preferred format for a readme, add these metadata to any word processing document type with which you are most comfortable (from a Word doc to Markdown): data curators can convert files as needed.

Helpful Links

• File naming conventions and folder structures: https://libguides.lib.rochester.edu/dmsplans/organizing
• ASCII Tree Generator (creates trees similar to the one pictured in the above example from your folder structure as-is: https://ascii-tree-generator.com/
• Tree (can be used to create hierarchies by hand): https://tree.nathanfriend.io/
• TREE |clip command (can be used in Windows environments to generate a text file of your directory listing): https://answers.microsoft.com/en-us/windows/forum/all/how-do-i-print-out-folder-name-and-its-sub-folder/b3ffa9d5-3331-45d5-b3f2-d99a66588865

---

Credits

This readme template was adapted in part from suggestions created by Cornell University (https://data.research.cornell.edu/data-management/sharing/readme/) and Mozilla Science Lab (https://mozillascience.github.io/open-data-primers/2.3-data-readme.html) by University of Rochester Data Services.

20240703 Revision 3