Coding principles

[luizaandrade]

Choose wisely

• Link to example main R script from "choose wisely"
• Link to example main do-file from "choose wisely"
• Find a good comparison of software to link from "choose wisely". This is not bad, but it's outdated.
• Link to automation principle from second paragraph

Be kind to your reader

• Example of code that uses bad indentation
• Example of code where inputs are not clear (link to Stata style guide once this PR is merged)
• Link to example of code that documents why something is done as well as what is being done
• Link to example of code with self-documenting workflow
• Link to plan for updating readme file from "be kind to your reader"

Live forever

• Link to project setup with renv, conda environments or adopath on last bullet point
• Link to automation principle on second bullet point

Track changes

• Link to example on how to track changes to metadata
• Link to GDP principle

DRY

• Link to how to (not) write loops in R
• Link to how to write loops in Stata
• Link to how to write loops in Python
• Link to how to write functions in R
• Link to how to write functions in Stata
• Link to how to write functions in Python
• Link to example of how repetitive code is error-prone
• Link to data analysis guide (from example in text)

Ask questions

• Link to examples of how to read help files
• Link to examples of how to see help files

Continuous testing

• Link to automation principle
• Link to examples of code testing

There's more to learn

• Link to cheatsheets