Skip to content

coding style guide

andybeet edited this page Jun 10, 2025 · 2 revisions

To collaborate effectively and efficiently, we need to follow some coding guidelines. These guidelines will help us maintain a consistent codebase, improve readability, and facilitate collaboration among team members. We borrow from the tidyverse style guide, but we also have some specific practices that we follow in our projects.

We encourage all members to read the tidyverse style guide and follow its principles. While we don't have any plan to refactor old code, we hope that new code will follow these guidelines.

Best practices for R coding include:

  • Automatic formatting for:
    • Rstudio (Air). Requires Rstudio 2024.12.0
    • Positron (Air extension)
  • Naming things
  • Documenting code
  • Assignment operator
  • Functions
  • Packages

Clone this wiki locally