R: Create a style guide

create_style_guide {styler} | R Documentation

## Create a style guide

### Description

This is a helper function to create a style guide, which is technically speaking a named list of groups of transformer functions where each transformer function corresponds to one styling rule. The output of this function can be used as an argument for `style` in top level functions like `style_text()` and friends.

### Usage

    create_style_guide(initialize = default_style_guide_attributes,
      line_break = NULL, space = NULL, token = NULL, indention = NULL,
      use_raw_indention = FALSE, reindention = tidyverse_reindention())

### Arguments

`initialize` | The bare name of a function that initializes various variables on each level of nesting.
`line_break` | A list of transformer functions that manipulate line_break information.
`space` | A list of transformer functions that manipulate spacing information.
`token` | A list of transformer functions that manipulate token text.
`indention` | A list of transformer functions that manipulate indention.
`use_raw_indention` | Boolean indicating whether or not the raw indention should be used.
`reindention` | A list of parameters for regex re-indention, most conveniently constructed using `specify_reindention()`.

### Examples

    set_line_break_before_curly_opening <- function(pd_flat) {
      op <- pd_flat$token %in% "'{'"
      pd_flat$lag_newlines[op] <- 1L
      pd_flat
    }
    set_line_break_before_curly_opening_style <- function() {
      create_style_guide(line_break = tibble::lst(set_line_break_before_curly_opening))
    }
    style_text("a <- function(x) { x }", style = set_line_break_before_curly_opening_style)

[Package styler version 1.0.2 Index]