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

Non-invasive pretty printing of R code
https://github.com/r-lib/styler

pretty-print r

Last synced: about 2 months ago
JSON representation

Non-invasive pretty printing of R code

• Host: GitHub
• URL: https://github.com/r-lib/styler
• Owner: r-lib
• License: other
• Created: 2017-02-08T19:16:37.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-07-15T05:56:53.000Z (2 months ago)
• Last Synced: 2024-07-28T09:34:48.912Z (about 2 months ago)
• Topics: pretty-print, r
• Language: R
• Homepage: https://styler.r-lib.org
• Size: 19.4 MB
• Stars: 703
• Watchers: 14
• Forks: 70
• Open Issues: 59
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - r-lib/styler - Non-invasive pretty printing of R code (R)

README

        
---

output: github_document

editor_options: 

  markdown: 

    wrap: 79

---

```{r, echo = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "README-"

)

```

# {styler}: Non-Invasive Pretty Printing of R Code

[![R build status](https://github.com/r-lib/styler/workflows/R-CMD-check/badge.svg)](https://github.com/r-lib/styler/actions)

[![Lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)

[![Test coverage](https://codecov.io/gh/r-lib/styler/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/styler?branch=main)

[![CRAN Status](https://www.r-pkg.org/badges/version/styler)](https://cran.r-project.org/package=styler)

# Overview 

styler formats your code according to the [tidyverse style

guide](https://style.tidyverse.org) (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")`

```{r, out.width = "650px", echo = FALSE}

knitr::include_graphics("https://raw.githubusercontent.com/lorenzwalthert/some_raw_data/master/styler_0.1.gif")

```

## Installation

You can install the package from CRAN.

```{r, eval = FALSE}

install.packages("styler")

```

Or get the development version from GitHub:

```{r, eval = FALSE}

# install.packages("remotes")

remotes::install_github("r-lib/styler")

```

## Documentation

The following online docs are available:

-   [latest CRAN release](https://styler.r-lib.org).

-   [GitHub development version](https://styler.r-lib.org/dev/).

## Acknowledgments

Hex sticker font is [Gayathri](https://fonts.google.com/specimen/Gayathri), and 

the image is taken from icon made by [Freepik](https://www.freepik.com) and 

available at [flaticon.com](https://www.flaticon.com/free-icon/suit).