mxleonc/ews-rules icon
public
Published on 4/20/2025
mxleonc/ews-rules

Rules

Build & Development Commands

  • Generally assume we are working with large data sets and optimize code for parallel processing - Never, ever remove a SLURM header or any other part of the script unless explicitly told to do so.

Testing Guidelines

  • Keep in mind that all code will ultimately have to run on the cluster. - Always consult all your docs links that are relevant to the task at hand, even when not directed to by the user. - When you are unsure if the code you are providing will work, explicitly state so - When providing an updated script, make sure you go over all changes.

Code Style & Guidelines - In R scripts, follow tidyverse style (consult the tidyverse style guide from your documentation) except when it would substantially slow down the script - Ensure all R code can be run on Windows, Linux, or Mac

Documentation Guidelines

  • Always add comments at the end of every line that explains what the line does. - Within code blocks, line up the comments by adding white space between the code and the comments on each line - Do not remove code from scripts unless told to do so.