Contributing

mrgsolve development has adopted these development principles and styles.

• Use base R where possible
  • Use base R string processing; avoiding stringi and stringr until there's a compelling reason to use it
  • Use base R for all system calls
• All imports get registered in Aaaa.R
• Do not prefix with pkg:: when calling imported functions unless compelling case
• Use if(...) not if (...)
• for loops are good in the right circumstances
• We follow R pattern when documenting function arguments: start with lower case and end with .; there is currently a mix of styles and we are working to make it consistent.
• Minor code linting is encouraged as long as it is in the vicinity of changes in the current PR
• Roxygen documentation starts with #'; I don't know why I started with ##' but I did; as we change code we'll be changing this too

TODO

Documentation

• Check every function for description
• Put a period after argument descriptions
• Switch to md
• Revert some documentation entries that start with capital
• Convert ##' to #'