stylerignore {styler}R Documentation

Turn off styling for parts of the code

Description

Using stylerignore markers, you can temporarily turn off styler. See a few illustrative examples below.

Details

Styling is on by default when you run styler.

To use something else as start and stop markers, set the R options styler.ignore_start and styler.ignore_stop using options(). If you want these settings to persist over multiple R sessions, consider setting them in your R profile, e.g. with usethis::edit_rprofile().

Examples

# as long as the order of the markers is correct, the lines are ignored.
style_text(
  "
  1+1
  # styler: off
  1+1
  # styler: on
  1+1
  "
)

# if there is a stop marker before a start marker, styler won't be able
# to figure out which lines you want to ignore and won't ignore anything,
# issuing a warning.
## Not run: 
style_text(
  "
  1+1
  # styler: off
  1+1
  # styler: off
  1+1
  "
)

## End(Not run)


[Package styler version 1.3.2 Index]