Package 'tergo'

Get the default configuration

Description

This configuration is used by the styling functions if no value is provided for the configuration keys. It can also serve as the base for you custom configuration.

Usage

get_default_config()

Details

The configuration values:

• indent (integer) - the number of spaces to use for indentation. E.g. 2L, 4L.

• line_length (integer) - the maximum number of characters in a line. E.g. 80L, 120L.

• embracing_op_no_nl (logical) - whether to allow a newline after an embracing operator. E.g. TRUE, FALSE.

• allow_nl_after_assignment (logical) - whether to allow a newline after an assignment operator. E.g. TRUE, FALSE.

• space_before_complex_rhs_in_formula (logical) - whether to add a space before a complex right-hand side in a formula. E.g. TRUE, FALSE.

• strip_suffix_whitespace_in_function_defs (logical) - whether to strip suffix whitespace in function definitions. E.g. TRUE, FALSE.

• function_line_breaks (character) - the type of line breaks in function definitions when arguments do not fit. Possible values are: "hanging", "double", "single".

• insert_newline_in_quote_call (logical) - whether to insert a newline in calls to quote. E.g. TRUE, FALSE.

Value

list with the default configuration

Examples

config <- get_default_config()
print(config)

# Make the indent 4 spaces
config$indent <- 4L

# Make the maximum line length 80 characters
config$line_length <- 80L

# Make the function line breaks double
config$function_line_breaks <- "double"

---

Style a package

Description

Style a package

Usage

style(config_file = "tergo.toml", configuration = list(), ...)

Arguments

config_file	(character) The path to the configuration file. Default "tergo.toml".
configuration	(list) Configuration for formatting. Default list().
...	additional parameters to style_pkg()

Details

Configuration is read from a file named tergo.toml in the root of the package. The precedence of the configuration is (from the highest to lowest):

1. The configuration passed to the function.

2. The configuration file.

To see possible configuration options, see get_default_config().

Value

No return value, called for side effects.

Examples

style()
style(config_file = "tergo.toml", configuration = list())

---

Style a file

Description

Style a file

Usage

style_file(file, configuration = list())

Arguments

file	(character) path to the file to format.
configuration	(list) Configuration for formatting. Default list().

Details

To see possible configuration options, see get_default_config().

Value

(logical) whether the file was formatted successfully or skipped. TRUE - formatted successfully, FALSE - skipped.

Examples

tmp <- tempfile()
file_conn <- file(tmp)
writeLines(c("function(){}", "A<-7"), file_conn)
close(file_conn)
style_file(file = tmp, configuration = list())
unlink(tmp)

---

Style a package

Description

Style a package

Usage

style_pkg(
  path = ".",
  config_file = "tergo.toml",
  configuration = list(),
  force = FALSE,
  extensions = c(".R", ".r"),
  verbose = interactive()
)

Arguments

path	(character) The path to the package. Default ".".
config_file	(character) The path to the configuration file. Default "tergo.toml".
configuration	(list) Configuration for formatting. Default list().
force	(logical(1)) Whether to format the files even if no package was found. TRUE - format the .R and .r files found in the directory (recursive). FALSE exit without formatting anything. Default FALSE.
extensions	(character) The extensions of the files to format. Default c(".R", ".r").
verbose	(logical(1)) Whether per file status and run statistics should be printed. Default interactive().

Details

Configuration is read from a file named tergo.toml in the root of the package. The precedence of the configuration is (from the highest to lowest):

1. The configuration passed to the function.

2. The configuration file.

To see possible configuration options, see get_default_config().

Value

No return values, called for side effects.

Examples

style_pkg()
style_pkg(path = "./tergo", config_file = "custom_tergo.toml", verbose = TRUE)

---

Style text

Description

Style text

Usage

style_text(text, configuration = list())

Arguments

text	(character) the text to style
configuration	(list) Configuration for formatting. Default list().

Details

This function is vectorized. To see possible configuration options, see get_default_config().

Value

(character) The text formatted as R code.

Examples

code <- "a+b"
styled <- style_text(code)
code <- c("a+b", "A<-7")
styled <- style_text(code)

---