Learn R Programming

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

styler

Overview

styler formats your code according to the tidyverse style guide (or your custom style guide) so you can direct your attention to the content of your code. It helps to keep the coding style consistent across projects and facilitate collaboration. You can access styler through

the RStudio Addin as demonstrated below
R functions like style_pkg(), style_file() or style_text()
various other tools described in vignette("third-party-integrations")

Installation

You can install the package from CRAN.

install.packages("styler")

Or get the development version from GitHub:

# install.packages("remotes")
remotes::install_github("r-lib/styler")

Documentation

The following online docs are available:

Copy Link

Version

Install

install.packages('styler')

Monthly Downloads

48,570

Version

1.8.1

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

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

Homepage

https://styler.r-lib.org

Maintainer

Lorenz Walthert

Last Published

November 7th, 2022

Functions in styler (1.8.1)

add_token_terminal

Add information about previous / next token to each terminal

Clear the cache

add_id_and_short

Add column pos_id and short

apply_ref_indention_one

Applying reference indention of a target token

alignment_col1_all_named

Checks if all arguments of column 1 are named

alignment_ensure_trailing_comma

Ensure last pd has a trailing comma

Activate or deactivate the styler cache

bind_with_child

Bind a parse table with one of its children

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

cache_by_expression

Check token validity

assert_transformers

Assert the transformers

Remember the past to be quicker in the future

Show information about the styler cache

cache_find_path

Where is the cache?

cache_find_block

Find the groups of expressions that should be processed together

Invoke a system command

apply_transformers

Apply transformers to a parse table

assert_filetype

Make sure all supplied file types are allowed

Write to the cache

cache_more_specs

Create more specs

Make a key for R.cache

cache_is_activated

Check if a cache is activated

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

catch_style_file_output

Capture and post-process the output of style_file without causing side effects

construct_vertical

Construct an object of class vertical

combine_children

Combine child and internal child

communicate_warning

Communicate a warning if necessary

compute_parse_data_nested

Obtain a nested parse table from a character vector

choose_indention

Choose the indention method for the tokens

context_to_terminals

Propagate context to terminals

contains_else_expr_that_needs_braces

Check whether an else expression needs braces

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

create_style_guide

Create a style guide

communicate_summary

Communicate the summary of styling

compute_indent_indices

Compute the indices that need indention

Create a terminal token

default_style_guide_attributes

Initialize default style guide attributes

copy_to_tempdir

Copy a file to a temporary directory

Create a tree from text

The elements that are added to this environment are:

env_add_stylerignore

Add positional information of token to next terminal

ensure_correct_txt

Ensure a correct text of all strings and numeric constants

create_node_from_nested

Create node from nested parse data

enrich_terminals

Enrich flattened parse table

convert_newlines_to_linebreaks

Replace the newline character with a line break

context_towards_terminals

Update the a parse table given outer context

Convert roxygen comments to Rd code

drop_cached_children

Drop all children of a top level expression that are cached

enhance_mapping_special

Enhance the mapping of text to the token "SPECIAL"

find_pos_id_to_keep

Find the pos ids to keep

create_node_from_nested_root

Convert a nested data frame into a node tree

dir(), but without dot-prefix and different defaults

Create valid pos_ids if possible

find_line_break_position_in_multiline_call

Find index of the token before which the line should be broken

finalize_raw_chunks

Drop start / stop, when formatting is turned off

Find the block to which a token belongs

extract_terminals

Extract terminal tokens

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.

dir_without_._one

dir(), but with full names, ignored case, and included hidden files and recursive.

ensure_last_n_empty

Ensure there is one (and only one) blank line at the end of a vector

find_blank_lines_to_next_block

Number of lines between cache blocks

Find dontrun and friend sequences

expressions_are_identical

Check whether two expressions are identical

find_blank_lines_to_next_expr

Find blank lines

Replace single quotes with double quotes

flatten_operators_one

Flatten one level of nesting with its child

flatten_operators

Flatten some token in the nested parse table based on operators

get_knitr_pattern

Get chunk pattern

get_engine_pattern

What's the engine pattern for rmd code chunks?

Flatten a parse table

get_addins_style_transformer_name

Return the style function or name

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.

find_tokens_to_update

Find the tokens to update when applying a reference indention

hash_standardize

Standardize text for hashing

Check if text is cached

if_for_while_part_requires_braces

Check if if, for or while loop expression require a braces.

identify_raw_chunks

Identifies raw Rmd or Rnw code chunks

identify_start_to_stop_of_roxygen_examples_from_text

Figure out where code examples start and stop

find_start_pos_id

Find legit starting value for a new positional id

initialize_attributes

Initialize attributes

has_crlf_as_first_line_sep

Check if a string uses CRLF EOLs

Obtain robust parse data

Drop-in replacement for xfun:::invalid_utf8()

math_token_spacing

Specify spacing around math tokens

Identify comments that are shebangs

is_insufficiently_parsed_string

Identify strings that were not fully parsed

Lookup all tokens that have a unique token-text mapping

n_times_faster_with_cache

Times two function calls with temporarily enabled cache

make_transformer

Closure to return a transformer function

match_stop_to_start

Match a stop candidate to a start

map_filetype_to_pattern

Map the file type to a corresponding regular expression

Parse roxygen comments into text

is_code_chunk_header_or_xaringan_or_code_output

Identify spinning code chunk header or xaringan

local_test_setup

Establish testing setup for current environment

Get the value of an option

needs_rd_emulation

Check if rd emulation is required with roxygen2::roc_proc_text()

Save parsing from text

lookup_new_special

Lookup which new tokens were created from "SPECIAL"

next_non_comment

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

Print styled code

nest_parse_data

Nest a flat parse table

Prettify a package

Tell me what the next terminal is

What is a parse table representing?

parse_transform_serialize_roxygen

Parse, transform and serialize roxygen comments

parse_transform_serialize_r

Parse, transform and serialize text

pd_is_multi_line

Check whether a parse table is a multi-line token

remove_dont_mask

Remove dont* mask

needs_indention_one

Check whether indention is needed

needs_indention

Check whether indention is needed

parse_transform_serialize_r_block

Parse, transform and serialize a nested parse table

Specify what is re-indented how

parse_tree_must_be_identical

Check whether a round trip verification can be carried out

parser_version_set

Work with parser versions

relocate_eq_assign

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

Drop-in replacement for xfun::read_utf8(), with an optional warn argument.

remove_roxygen_header

Remove roxygen header

set_arg_write_tree

Set the write_tree argument

Repeat elements of a character vector times times and collapse it

roxygen_remove_extra_brace

Fix tools::parse_Rd() output

Prettify R code in current working directory

post_parse_roxygen

Changing the line definition

set_and_assert_arg_filetype

Set the file type argument

Standardize paths in root

set_line_break_around_curly_curly

Styling around \{\{

set_line_break_before_curly_opening

Set line break before a curly brace

serialize_parse_data_flattened

Serialize flattened parse data

save_after_styling_is_active

Heuristic to see if a file styled with the addin should be saved or not.

Helper for setting spaces

scope_normalize

Convert the styling scope to its lower-level representation

specify_transformers_drop

Specify which tokens must be absent for a transformer to be dropped

separate_chunks

Separate chunks within Rmd and Rnw contents

set_unindention_child

Unindent a child if necessary

relocate_eq_assign_one

Relocate an assignment expression

set_space_between_eq_sub_and_comma

Set space between EQ_SUB and "','"

relocate_eq_assign_nest

Relocate all assignment expressions that contain EQ_ASSIGN within a nest

set_style_transformers

Asks the user to supply a style

set_space_between_levels

Set space between levels of nesting

Prettify R source code

set_regex_indention

Set indention of tokens that match regex

set_line_break_after_opening_if_call_is_multi_line

Sets line break after opening parenthesis

set_space_around_op

Set spaces around operators

split_roxygen_segments

Split text into roxygen and non-roxygen example segments

style_roxygen_code_example

Style a roxygen code example that may contain dontrun and friends

start_comments_with_space

Start comments with a space

Style files with R source code

Prettify arbitrary R code

style_roxygen_code_example_segment

Style a roxygen code example segment

style_roxygen_example_snippet

Given a code snippet is dont* or run, style it

style_active_pkg

Wrapper around style_pkg() for access via Addin.

set_line_break_if_call_is_multi_line

Set line break for multi-line function calls

style_roxygen_code_example_one

Style a roxygen code example with exactly one @example or @exampleIf

Set the multi-line column

style_text_without_curly_curly

style_text() without rules for \{\{

Obtain token table from text

transform_and_check

Transform a file an check the result

style_selection

Styles the highlighted selection in a .R or .Rmd file.

tidyverse_style

The tidyverse style

Turn off styling for parts of the code

stylerignore_consolidate_col

Consolidate columns after a merge

style_space_around_math_token

Style spacing around math tokens

test_collection

Run a collection of tests

style_space_around_token

Set spacing of token to a certain level

Stylers for RStudio Addins

Non-invasive pretty printing of R code

text_to_flat_pd

Creates a flat parse table with minimal initialization

Create the path to a test that file

transform_files

Transform files with transformer functions

Test the dry argument

Transform code from R, Rmd or Rnw files

Unindent a child

try_transform_as_r_file

Style a file as if it was an .R file

token_is_on_aligned_line

Check if tokens are aligned

validate_new_pos_ids

Validate sequence of new position ids

Transform a flat parse table with a list of transformers

update_indention

Update indention information of parse data

unindent_fun_dec

Revert the indention of function declaration header

transform_mixed

Transform mixed contents

verify_roundtrip

Verify the styling

test_transformers_drop

Test transformers_drop for consistency

transform_mixed_non_empty

Ensure for .Rmd and friends that a code chunk without code is formatted as a code chunk without any lines.

Apply a function to the contents of a file

wrap_expr_in_expr

Wrap an expression into an expression

transform_utf8_one

Potentially transform a file

test_transformer

Transforming test input with a transformer function

wrap_subexpr_in_curly

Wrap a sub-expression in curly braces

wrap_multiline_curly

Wrap a multi-line statement in curly braces

Transform a file and output a customized message

update_newlines

Update the newlines attribute

Drop-in replacement for xfun::write_utf8()

update_indention_ref

Update the indention reference

wrap_expr_in_curly

Wrap an expression in curly braces

transformers_drop

Remove transformers that are not needed

wrap_if_else_while_for_fun_multi_line_in_curly

Wrap if-else, while and for statements in curly braces

wrap_else_multiline_curly

Add curly braces to else

add_roxygen_mask

Add the roxygen mask to code

alignment_drop_last_expr

Remove last expression

add_spaces_or_newlines

Concentrate newlines or spaces in a string

alignment_serialize_line

Serialize one line for a column

alignment_drop_comments

Remove all comment tokens

add_line_col_to_wrapped_expr

Adds line and col information to an expression from its child

add_stylerignore

Adds the stylerignore column

add_cache_block

Add the block id to a parse table

apply_ref_indention

Apply reference indention to tokens

alignment_ensure_no_closing_brace

Ensure the closing brace of the call is removed

alignment_serialize

Serialize text from a parse table

alignment_serialize_column

Serialize all lines for a given column

apply_stylerignore

Ensure correct positional information for stylerignore expressions

alignment_has_correct_spacing_around_comma

Check if spacing around comma is correct

alignment_has_correct_spacing_around_eq_sub

Check if spacing around = is correct