Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 1.63 KB

coding-etiquette.md

File metadata and controls

25 lines (13 loc) · 1.63 KB

Long object names are annoying to type - more letters, higher chance you’ll make a typo.

Variable and function names should be lowercase.

Variable names should be nouns and function names should be verbs.

  • Use an underscore to separate words within a file.

  • Use a dot to separate words within objects and functions.

This way it’s clear what’s an object and what’s an external file.

The preferred form for variable names is all lower case letters and words separated with dots (variable.name). Function names have lowercase letters and words are separated with dots (function.name).

Spacing around infix operators (=, +, -, <-) - should there be spaces?

Line length - how long should a line of code be?

The official convention is to limit your code to 80 characters per line. Having to continuously scroll left and write can be annoying and confusing. Also, when you publish your code on Github, the scrolly bar is all the way down, so to scroll right, you first need to scroll all the way down, scroll right, then scroll all the way up to wherever you want to be - unnecessary.

How do you know what’s 80 characters though? RStudio can place a handy line in your editor as a reminder! Go to Tools/Global Options/Code/Display/Show Margin/80 characters. Sometimes it might make more sense for your code to be a bit longer than 80 characters, but in general code is easier to read if there is no need for continuous scrolling left and right.

When using pipes, keep the piping operator %>% at the end of the line and continue your pipe on a new line.

When using ggplot2, keep the + at the end of the line and continue adding on layers on a new line.