style_text: Like 'styler::style_text()', but 'style' defaulting to...

Description Usage Arguments

View source: R/re-export.R

Description

See styler::style_text() for details, examples and more.

Usage

1
2
3
4
5
6
7
8
style_text(
  text,
  ...,
  style = putyourstyleguidehere_style,
  transformers = style(...),
  include_roxygen_examples = TRUE,
  base_indention = 0
)

Arguments

text

A character vector with text to style.

...

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'.

include_roxygen_examples

Whether or not to style code in roxygen examples.

base_indention

Integer scalar indicating by how many spaces the whole output text should be indented. Note that this is not the same as splitting by line and add a base_indention spaces before the code in the case multi-line strings are present. See 'Examples'.


BioSisyphus/styler.unify documentation built on Dec. 17, 2021, 10:55 a.m.