readme button

[Danny-dK]

[EDIT] This discussion point was entered in issues by me at a later time point as a feature request. See #217

Would it be a good idea to also offer the creation of a readme.txt within Yoda in a GUI type way as the metadata button? In general you would expect it easy to create a readme.txt by individuals themselves, but over the past 5 years I note that there is a wide variety of people comfortable creating a nicely formatted and structured readme file. Such a thing could possibly be done by offering a 'readme' button next to the 'metadata' button and would complement Yoda as a data management platform. The terms I would consider are:

• Title (free text field or copied by the metadata file)
• More detailed description of study including measurements made (free text field).
• Folder structure (perhaps this could be automatically created by Yoda?)
• Folder contents (perhaps text boxes automatically generated by Yoda from the previous term with free text fields)
• File formats present (list generated by Yoda)
• Codebook (free text field)
• Other remarks (free text field)
• + free to add new text fields when required with a user-specified header on each.

After saving, a txt document could then be generated with a specified line length and clear header indications so that it is nicely and uniformly formatted between publications.

This would also benefit data managers that need to curate submittals to vault or for publication and is easier than communicating to the user through email that a readme file is beneficial.

[Danny-dK]

Closing discussion for now. readme.so could be a platform to use and there is a pull request available octokatherine/readme.so#274 in which one can export and import templatea that can be used by researchers https://readme-7o4rklwrq-katherineoelsner.vercel.app/editor. It does seem that readme.so is not really very much active as pull requests seem to take a long time. I guess for now it would be best to have your own template created (in markdown or just simple txt file) and spread that within the institute for researchers to use.