Home

Coding standards for heemod

• Try to divide the code in meaningful functions, write bricks not monoliths.
• Write tests for all the features you add with the testthat package.
• Document all your functions with the roxygen package.
• Only export functions needed by the user. For simplicity of use keep the number of exported functions as low as possible. Consider using generics.
• Use S3 generics. Avoid S4.
• Use Hadley Wickham style guide.
• Use snake case variable naming.