03. Writing Style

Packages

When referring to packages, they should be emphasized in bold text in their first mention, and plain text thereafter.

• Do: The distill package is awesome. Have you tried distill?
• Do: distill is an awesome package. I first started using distill last year.
• Don’t: The distill package is awesome. I love distill.
• Don’t: The distill package is awesome. I love distill.

Consider citing the author(s) of the package when introducing it too.

Inline code and math

Sentences should not start with inline code.

• Do: The print() function prints its argument and returns it invisibly.
• Don’t: print() prints its argument and returns it invisibly.

This rule applies to inline math too.

• Do: The variable t represents the number of seconds elapsed.
• Don’t: t represents the number of seconds elapsed.

Code Chunks

Follow the tidyverse style guide