Readability

Video

Slides

Exercise

• Run a linter through your code and identify style issues:

  • R: lintr
  • Python: flake8

• Edit your code to improve the style compatibility, based on the feedback from your linter.

• Run an autoformatter through your code to automatically fix issues instead of simply flagging them:

  • R: styler
  • Python: black

Tip

You can use git commands to see the changes made by the autoformatter. Try git diff.

• If you find code that is hard to read, or variable names that need adjusting, make a note to work on it. Use #TODO or another consistent label so you can extract these notes later.