This README file was generated on [YYYY-MM-DD] (YYYY-MM-DD) by [NAME]. Last updated: [YYYY-MM-DD]. ------------------- GENERAL INFORMATION ------------------- // Title of Dataset: // Contact Information // Name: // Institution: // Email: // ORCID: // Code repository URL: // Contributors: See metadata field Contributor. // Data Type: See metadata field Data Type. // Date of data production: See metadata field Production Date . // Geographic location: See metadata section Geographic Coverage. // Funding sources: See metadata section Grant Information. // Short description of what the dataset is about, including reference to related project(s) and publication(s), if applicable.: -------------------------- SHARING/ACCESS INFORMATION -------------------------- (See metadata record for dataset.) // Licenses/Restrictions: See Terms section. // Links to publications that cite or use the data: See metadata field Related Publication. // Links/relationships to related data sets: See metadata field Related Datasets. // Data sources: See metadata field Data Sources. // Recommended citation: See citation generated by repository. -------------------- DATA & FILE OVERVIEW -------------------- // File List: // Relationship between files, if important: // Is this a new version of a previously published dataset? yes/no File name: Why was the file updated?: When was the file updated (YYYY-MM-DD)?: ---------------------- HOW TO USE THE DATASET ---------------------- // Getting Started: a. Prerequisites b. Installing // Running the tests a. Break down into end to end tests b. Coding style tests // Deployment ---------------------------------- CODE DOCUMENTATION FOR: [FILENAME] ---------------------------------- < Acknowledgements. This README file template is adapted from the following documents/resources: AJPS. ‘American Journal of Political Science Qualitative Data Verification Checklist’. Wiley, 11 March 2016. https://ajps.org/wp-content/uploads/2019/01/ajps-qualdata-checklist-ver-1-0.pdf. Berkeley Library, University of California. How to Write a Good Documentation. Available at: http://guides.lib.berkeley.edu/how-to-write-good-documentation Cornell University. Guide to writing readme style metadata. Available at: https://data.research.cornell.edu/content/readme#bestpractices Corti, Louise, Veerle Van den Eynden, Libby Bishop, Matthew Woollard, Maureen Haaker, and Scott Summers. Managing and Sharing Research Data: A Guide to Good Practice. 2nd edition. Los Angeles: SAGE, 2019. Dryad. Best practices for creating reusable data publications. Available at: https://datadryad.org/stash/best_practices#describe PurpleBooth. A template to make good README.md. Available at: https://gist.github.com/PurpleBooth/109311bb0361f32d87a2 University of Bath. Working with data: Data Documentation and Metadata. Available at: https://library.bath.ac.uk/research-data/working-with-data/data-documentation-metadata Zalando. Zalando's README Template. Available at: https://github.com/zalando/zalando-howto-open-source/blob/master/READMEtemplate.md#readme >