4: Code styleguides

Jump to bottom

Bianca Sacchi edited this page Feb 9, 2023 · 2 revisions

If you're writing code in the lab, you should adopt the following principles:

Keep it either in a Github repository, or if it's really small or a one-off, in Gist. This seems like a pain, but it's the best way to ensure that new versions are accessible to others in the lab, and that if you leave, we have a record of your work. Ideally, all projects will have READMEs and their code checked into a Git repository, hosted on Github (but don't use track data with Git).
Write code for humans: comment and document your code, break code down into modular components, and use the styleguides provided below.

Adopting Styleguides

Google has styleguides for some languages we use in the lab:

C++
Python, see also PEP8.
Shell, see also Writing Robust Shell Scripts
R

We also use Perl and C in the lab, but these do not have styleguides.

~~borrowed from rilab.org~~

This wiki is currently being updated. Contributions by Tyler Kent, Julia Kreiner, Zoe Humphries, Joanna Rifkin and Bianca Sacchi.