rspkg: Aliases styler::style_pkg()

Description Usage Arguments See Also

View source: R/pkg_aliases.R

Description

Aliases styler::style_pkg()

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
rspkg(
  pkg = ".",
  ...,
  style = styler::tidyverse_style,
  transformers = style(...),
  filetype = c("R", "Rprofile"),
  exclude_files = "R/RcppExports.R",
  exclude_dirs = c("packrat", "renv"),
  include_roxygen_examples = TRUE
)

Arguments

pkg

Path to a (subdirectory of an) R package.

...

Arguments passed on to the style function.

style

A function that creates a style guide to use, by default tidyverse_style() (without the parentheses). Not used further except to construct the argument transformers. See style_guides() for details.

transformers

A set of transformer functions. This argument is most conveniently constructed via the style argument and .... See 'Examples'.

filetype

Vector of file extensions indicating which file types should be styled. Case is ignored, and the . is optional, e.g. c(".R", ".Rmd"), or c("r", "rmd"). Supported values (after standardization) are: "r", "rprofile", "rmd", "rnw".

exclude_files

Character vector with paths to files that should be excluded from styling.

exclude_dirs

Character vector with directories to exclude. Note that the default values were set for consistency with style_dir() and as these directories are anyways not styled.

include_roxygen_examples

Whether or not to style code in roxygen examples.

See Also

styler::style_pkg()


jeksterslabds/jeksterslabRpkg documentation built on Jan. 22, 2021, 11:43 p.m.