Learn R Programming

⚠️There's a newer version (1.10.3) of this package.Take me there.

styler

The goal of styler is to provide non-invasive pretty-printing of R source code while adhering to the tidyverse formatting rules. Support for custom style guides is planned.

You can install the package from GitHub:

# install.packages("remotes")
remotes::install_github("krlmlr/styler")

You can style a simple character vector of code with style_text():

ugly_code <- "a<-function( x){1+1}           "
style_text(ugly_code)
#> a <- function(x) {
#>   1 + 1
#> }

There are a few variants of style_text():

style_file() styles .R and/or .Rmd files.
style_dir() styles all .R files in a directory.
style_pkg() styles the source files of an R package.
RStudio Addins for styling the active file, styling the current package and styling the highlighted code region.

You can find more information on the wiki of Google Summer of Code 2017 or check out the pkgdown page.

Copy Link

Version

Install

install.packages('styler')

Monthly Downloads

46,574

Version

0.0-10

License

GPL-3

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/r-lib/styler

Homepage

https://r-lib.github.io/styler/

Maintainer

Lorenz Walthert

Last Published

April 8th, 2024

Functions in styler (0.0-10)

apply_ref_indention

Apply reference indention to tokens

Assert text to be of positive length and replace it with the empty string otherwise.

Check token validity

add_id_and_short

Add column pos_id and short

bind_with_child

Bind a parse table with one of its children

add_line_col_to_wrapped_expr

Adds line and col information to an expression from its child

apply_transformers

Apply transformers to a parse table

add_spaces_or_newlines

Concentrate newlines or spaces in a string

Invoke a system command

can_verify_roundtrip

Check whether a roundtrip verification can be carried out

add_token_terminal

Add information about previous / next token to each terminal

create_style_guide

Create a style guide

apply_ref_indention_one

Applying reference indention of a target token

Create a terminal token

Flatten a parse table

combine_children

Combine child and internal child

generate_test_samples

Generate a comprehensive collection test cases for comment / insertion interaction Test consist of if / if-else / if-else-if-else cases, paired with various line-break and comment configurations. Used for internal testing.

compute_indent_indices

Compute the indices that need indention

character_to_ordered

Convert a character vector to an ordered factor

compute_parse_data_nested

Obtain a nested parse table from a character vector

choose_indention

Choose the indention method for the tokens

Construct *-out.R from a *-in.R

contains_else_expr_that_needs_braces

Check whether an else expression needs braces

context_towards_terminals

Update the a parse table given outer context

context_to_terminals

Propagate context to terminals

flatten_operators

Flatten some token in the nested parse table based on operators

create_node_from_nested

Create node from nested parse data

flatten_operators_one

Flatten one level of nesting with its child

identify_chunks

Identify chunks within Rmd contents

enrich_terminals

Enrich flattened parse table

create_node_from_nested_root

Convert a nested tibble into a node tree

extend_if_comment

Find the index of the last comment in the sequence of comments-only tokens after the token that has position pos in pd.

Create valid pos_ids if possible

get_knitr_pattern

Get chunk pattern

extract_terminals

Extract terminal tokens

Obtain robust parse data

serialize_parse_data_flattened

Serialize flattened parse data

relocate_eq_assign

Relocate the expressions containing the token EQ_ASSIGN within the nested parse table

style_space_around_math_token

Style spacing around math tokens

relocate_eq_assign_nest

Relocate all assignment expressions that contain EQ_ASSIGN within a nest

style_space_around_math_token_one

Set spacing of token to a certain level

initialize_attributes

Enrich parse table with space and line break information

test_transformer

Transforming test input with a transformer function

pd_is_multi_line

Check whether a parse table is a multi-line token

Create the path to a test that file

Unindent a child

Prettify R code in current working directory

update_indention

Update indention information of parse data

relocate_eq_assign_one

Relocate an assignment expression

make_transformer

Closure to return a transformer function

next_non_comment

Find the index of the next non-comment in a parse table

nest_parse_data

Nest a flat parse table

set_regex_indention

Set indention of tokens that match regex

Repeat elements of a character vector times times and collapse it

set_space_between_eq_sub_and_comma

Set space between EQ_SUB and "','"

Prettify R source code

Prettify arbitrary R code

Find the block to which a token belongs

Construct paths of a tree object given the paths of *-in.R files

lookup_new_special

lookup which new tokens were created from "SPECIAL"

construct_vertical

Construct an object of class vertical

Lookup all tokens that have a unique token-text mapping

Create a tree from text

math_token_spacing

Specify spacing around math tokens

Transform a file and output a customized message

wrap_expr_in_expr

Wrap an expression into an expression

transform_files

Transform files with transformer functions

wrap_if_else_multi_line_in_curly

Wrap if-else statement in curly braces

validate_new_pos_ids

Validate sequence of new position ids

parse_transform_serialize

Parse, transform and serialize text

Style .R and/or .Rmd files

Check whether a parse table corresponds to a a certain expression

transform_and_check

Transform a file an check the result

Set the multi-line column

Transform code from R or Rmd files

start_comments_with_space

Start comments with a space

set_unindention_child

Unindent a child if necessary

Stylers for RStudio Addins

verify_roundtrip

Verify the styling

test_collection

Run a collection of tests

update_indention_ref

Update the indention reference

Transform Rmd contents

update_newlines

Update the newlines attribute

try_transform_as_r_file

Style a file as if it was an .R file

Transform a flat parse table with a list of transformers

enhance_mapping_special

Enhance the mapping of text to the token "SPECIAL"

wrap_expr_in_curly

Wrap an expression in curly braces

find_start_line

Get the start right

set_line_break_if_call_is_multi_line

Set line break for multi-line function calls

find_start_pos_id

Find legit starting value for a new positional id

regex_for_reindention

Return regex patterns for re-indention

Specify what is re-indented how

needs_indention

Check whether indention is needed

set_space_between_levels

Set space between levels of nesting

needs_indention_one

Check whether indention is needed

tidyverse_style

The tidyverse style

Helper for setting spaces

Obtain token table from text

Non-invasive pretty printing of R code

Verify the text of strings

wrap_subexpr_in_curly

Wrap a sub-expression in curly braces

communicate_warning

Communicate a warning if necessary

copy_to_tempdir

Copy a file to a temporary directory

communicate_summary

Communicate the summary of styling

expressions_are_identical

Check whether two expressions are identical