TToolardo
← Useful Tips
Research workflowAcademic

README.md: Leave a plain-text README in serious calculation folders

Use README.md to leave a plain-text README in serious calculation folders. This small reproducibility habit pays off when a project is revisited months later.

README.md

Why it helps

Use README.md to leave a plain-text README in serious calculation folders. This small reproducibility habit pays off when a project is revisited months later.

How to use it

  1. Open the relevant app or terminal.
  2. Use the shortcut or command above in the relevant context.
  3. Check the result; for commands that change data, test on a small example first.
People also search for
README.md: Leave a plain-text README in serious calculation foldersREADME.mdleave a plain-text readme in serious calculation foldershow to leave a plain-text readme in serious calculation foldersResearch workflow leave a plain-text readme in serious calculation folders

Related tips

Research workflowSHA-256

SHA-256: Verify important files with a cryptographic hash

Use SHA-256 to verify important files with a cryptographic hash. This small reproducibility habit pays off when a project is revisited months later.

Research workflowraw/ · processed/ · results/

raw/ · processed/ · results/: Separate immutable raw data from processed data and results

Use raw/ · processed/ · results/ to separate immutable raw data from processed data and results. This small reproducibility habit pays off when a project is revisited months later.

Research workflowprovenance

provenance: Record input hashes, code versions and package versions with outputs

Use provenance to record input hashes, code versions and package versions with outputs. This small reproducibility habit pays off when a project is revisited months later.

Academic / OfficeWord Styles

Word Styles: Use Word styles for reliable document structure

Use Word styles for headings instead of manual bold/font sizing so navigation, TOCs and bulk formatting stay consistent.