---

name: r-style-guide description: Kyle's R coding style guide with tidyverse conventions and personal preferences. Use when writing or reviewing R code to ensure consistency. Covers quotes, indentation, pipes, naming, and markdown formatting.

Kyle's R Style Guide

Quote Usage

ALWAYS use single quotes unless one of these exceptions applies:

1. Regex expressions — double quotes for patterns
2. Strings with apostrophes — "Don't know" not 'Don\'t know'
3. User-facing messages — when message naturally contains apostrophes

Function Arguments & Indentation

Arguments MUST start on a new line after opening parenthesis. Never vertically align.

Copy# GOOD
result <- function_name(
  argument_1,
  argument_2,
  argument_3
)

# Also acceptable for very short calls
result <- function_name(arg1, arg2)

# BAD — vertical alignment
result <- function_name(argument_1,
                        argument_2)

Multi-line formulas — proper indentation:

Copy# GOOD
formula <- outcome ~ var1 + var2 +
  var3 + var4

# BAD
formula <- outcome ~ var1 + var2 +
                     var3 + var4

Indentation Rules

• 2 spaces per level (never tabs)
• Continuation lines indent by 2 spaces
• Pipe chains: indent each step by 2 spaces
• No trailing whitespace

Pipe Usage

• Use native pipe |> not %>%
• One operation per line
• Start pipe on same line as object

Copy# GOOD
result <- data |>
  filter(status == 'active') |>
  group_by(category) |>
  summarize(mean_value = mean(value, na.rm = TRUE))

# BAD
result <- data %>%
  filter(status == 'active')

• Maximum 90 characters per line

Markdown Lists — CRITICAL

Bulleted lists in markdown/Quarto MUST have 2 trailing spaces after each line:

CopyIntroduction with 2 spaces at end.
- First item with 2 trailing spaces
- Second item with 2 trailing spaces

Next paragraph.

Without trailing spaces, rendering breaks.