Coding Style Guide

Our philosophy is that the breseq core executables should have minimal external requirements and maximum compatibility for installation and compilation on a wide range of systems.

In order to ensure this is the case and for maintainability of the code, please follow these coding conventions:

• C++ code
  • In general, follow the Google C++ Style Guide.
  • Only utilize features available in the C++11 standard.
  • Do not link to any external convenience libraries (e.g., Boost).
• R code
  • In general, follow the Google R Style Guide.
  • Use only core libraries/functionality included with a base R install.

If you are writing a breseq extension in Python or R, you can utilize whatever other modules are needed for functionality. In these cases, we recommend releasing your code via PyPI or CRAN to manage requirements.