README Generator

README Generator

Data & File Overview

3.1 File list

List all files (or folders, as appropriate for dataset organization) contained in the dataset, with a brief description of the structure.

File list


3.2 File formats

Provide a brief organized list of the file formats you use. Wherever possible, sustainable file formats are best for archiving.

File formats


3.3 File abbreviations

Include description for any abbreviations used in your file names.

File abbreviations


3.4 File relationships

Include a description of the relationships between files, if important. For example, if you have a file named 202X-08-01_ProjectCodebook.csv that explains the variables in 202X-08-01ProjectDatafile.csv, state that here. Or, if you have both raw data files and processed data files, explain how they are related.

File relationships


3.5 Additional related data

Mention any data that was collected but not included in the current data package.

Additional related data


3.6 Dataset version

NOTE: This section will not be completed for your first version of this README file. We suggest keeping this section for future use and updating it if you change files within your dataset.

Dataset Version


3.7 Changelog

NOTE: This section will not be completed for your first version of this README file. If/When you update the version of your dataset, include information on what you have changed here. Which file(s) did you update? Why was/were the file(s) updated? When was the file updated? Repeat this section for each dataset, folder or file, as appropriate.

Changelog


Preview


JavaScript is disabled :(.