franfram / grkstyle

A Tidy R Code Style

grkstyle

grkstyle is an extension package for styler that holds my personal code style preferences.

Installation

You can install the grkstyle from Github

# install.packages("devtools")
devtools::install_github("gadenbuie/grkstyle")

Usage

To use grkstyle by default in styler functions and addins

# Set default code style for {styler} functions
grkstyle::use_grk_style()

Or add the following to your ~/.Rprofile

options(styler.addins_style_transformer = "grkstyle::grk_style_transformer()")

Examples

A few examples drawn from the tidyverse style guide.

Line Breaks Inside Function Calls

unstyled

do_something_very_complicated(something = "that", requires = many,
                              arguments = "some of which may be long")

grkstyle

do_something_very_complicated(
  something = "that",
  requires = many,
  arguments = "some of which may be long"
) 

styler::tidyverse_style

do_something_very_complicated(
  something = "that", requires = many,
  arguments = "some of which may be long"
) 

Indentation of Function Arguments

unstyled

long_function_name <- function(a = "a long argument",
                               b = "another argument",
                               c = "another long argument") {
  # As usual code is indented by two spaces.
}

grkstyle

long_function_name <- function(
  a = "a long argument",
  b = "another argument",
  c = "another long argument"
) {
  # As usual code is indented by two spaces.
} 

styler::tidyverse_style

long_function_name <- function(a = "a long argument",
                               b = "another argument",
                               c = "another long argument") {
  # As usual code is indented by two spaces.
}