9. Code and Technical Writing

Code block formatting

In R Markdown or Quarto, specify language using braces:

```{r}
# R code
```

```{python}
# Python code
```

```{html}
<!– HTML code –>
```

In plain Markdown, specify language without braces:

```r
# R code
```

```python
# Python code
```

```html
<!– HTML code –>
```

Inline code should be `marked` consistently.

Variable naming

Prefer camelCase for variables.
Use underscores mainly for spaces in filenames.

Mathematical expressions

Render using MathJax where possible, else LaTeX when supported.
Otherwise use clear text with proper spacing and typographic symbols. See also: Punctuation → Mathematical Operators.

Acronym expansion

Expand acronyms on first use (e.g., Attention Deficit/Hyperactivity Disorder (ADHD)).
Use <abbr> in HTML, or similar tools where supported.

Return to the manual index.

Licence

This work is licensed under the Creative Commons Attribution–NonCommercial 4.0 International Licence (CC BY-NC 4.0). You may copy, adapt, and share the material for any non-commercial purpose, provided that appropriate credit is given.

Full licence text: https://creativecommons.org/licenses/by-nc/4.0/

Commercial use:

For-profit institutions must obtain explicit written permission before using or adapting this material. Enquiries: hello@louisneilson.com