{"Type":"Package","Package":"styler","Title":"Non-Invasive Pretty Printing of R Code","Version":"1.3.0","Authors@R":"\nc(person(given = \"Kirill\",\nfamily = \"Mller\",\nrole = \"aut\",\nemail = \"krlmlr+r@mailbox.org\"),\nperson(given = \"Lorenz\",\nfamily = \"Walthert\",\nrole = c(\"cre\", \"aut\"),\nemail = \"lorenz.walthert@icloud.com\"))","Description":"Pretty-prints R code without changing the user's\nformatting intent.","License":"GPL-3","URL":"https://github.com/r-lib/styler","BugReports":"https://github.com/r-lib/styler/issues","Imports":"backports (>= 1.1.0), cli (>= 1.1.0), magrittr (>= 1.0.1),\npurrr (>= 0.2.3), R.cache (>= 0.14.0), rematch2 (>= 2.0.1),\nrlang (>= 0.1.1), rprojroot (>= 1.1), tibble (>= 1.4.2), tools,\nwithr (>= 1.0.0), xfun (>= 0.1)","Suggests":"data.tree (>= 0.1.6), digest, dplyr, here, knitr, prettycode,\nrmarkdown, rstudioapi (>= 0.7), testthat (>= 2.1.0)","VignetteBuilder":"knitr","Encoding":"UTF-8","LazyData":"true","RoxygenNote":"7.0.2","Collate":"'addins.R' 'communicate.R' 'compat-dplyr.R' 'compat-tidyr.R'\n'detect-alignment-utils.R' 'detect-alignment.R'\n'environments.R' 'expr-is.R' 'indent.R' 'initialize.R' 'io.R'\n'nest.R' 'nested-to-tree.R' 'parse.R' 'reindent.R'\n'token-define.R' 'relevel.R' 'roxygen-examples-add-remove.R'\n'roxygen-examples-find.R' 'roxygen-examples-parse.R'\n'roxygen-examples.R' 'rules-line-break.R' 'rules-other.R'\n'rules-replacement.R' 'rules-spacing.R' 'serialize.R'\n'set-assert-args.R' 'style-guides.R' 'styler.R'\n'stylerignore.R' 'testing-mocks.R' 'testing-public-api.R'\n'testing.R' 'token-create.R' 'transform-block.R'\n'transform-code.R' 'transform-files.R' 'ui-caching.R'\n'ui-styling.R' 'unindent.R' 'utils-cache.R' 'utils-files.R'\n'utils-navigate-nest.R' 'utils-strings.R' 'utils.R'\n'vertical.R' 'visit.R' 'zzz.R'","NeedsCompilation":"no","Packaged":"2020-02-10 21:26:42 UTC; lorenz","Author":"Kirill Mller [aut],\nLorenz Walthert [cre, aut]","Maintainer":"Lorenz Walthert ","Repository":"CRAN","Date/Publication":"2020-02-10 22:30:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/styler_1.3.0.tar.gz","jsonAuthors":[{"name":"Kirill Mller","email":"krlmlr+r@mailbox.org","maintainer":false},{"name":"Lorenz Walthert","email":"lorenz.walthert@icloud.com","maintainer":true}],"readme":"\n\n\n# styler\n\n[![Build\nStatus](https://travis-ci.org/r-lib/styler.svg?branch=master)](https://travis-ci.org/r-lib/styler)\n[![AppVeyor Build\nStatus](https://ci.appveyor.com/api/projects/status/github/r-lib/styler?branch=master&svg=true)](https://ci.appveyor.com/project/r-lib/styler)\n[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)\n[![codecov](https://codecov.io/gh/r-lib/styler/branch/master/graph/badge.svg)](https://codecov.io/gh/r-lib/styler)\n[![cran\nversion](https://www.r-pkg.org/badges/version/styler)](https://cran.r-project.org/package=styler)\n\nThe goal of styler is to provide non-invasive pretty-printing of R\nsource code while adhering to the\n[tidyverse](https://style.tidyverse.org) formatting rules. styler can be\ncustomized to format code according to other style guides too.\n\nThe following online docs are available:\n\n - [latest CRAN release](https://styler.r-lib.org).\n\n - [GitHub development version](https://styler.r-lib.org/dev).\n\n## Installation\n\nYou can install the package from CRAN.\n\n``` r\ninstall.packages(\"styler\")\n```\n\nIf you don’t use styler interactively (i.e. not from the R prompt or\nRstudio Addin), make sure you authorise `{R.cache}` once to set up a\npermanent cache. If you use it interactively, you will be asked to grant\nthis permission once. See `?caching` for details.\n\nOr get the development version from GitHub:\n\n``` r\n# install.packages(\"remotes\")\nremotes::install_github(\"r-lib/styler\")\n```\n\n## API\n\nYou can style a simple character vector of code with `style_text()`:\n\n``` r\nlibrary(\"styler\")\nugly_code <- \"a=function( x){1+1} \"\nstyle_text(ugly_code)\n#> a <- function(x) {\n#> 1 + 1\n#> }\n```\n\nThere are a few variants of `style_text()`:\n\n - `style_file()` styles .R, .Rmd .Rnw and .Rprofile, files.\n\n - `style_dir()` styles all .R and/or .Rmd files in a directory.\n\n - `style_pkg()` styles the source files of an R package.\n\n - RStudio Addins for styling the active file, styling the current\n package and styling the highlighted code\nregion.\n\n

\n\n## Configuration\n\nYou can decide on the level of invasiveness with the scope argument. You\ncan style:\n\n - just spaces.\n\n - spaces and indention.\n\n - spaces, indention and line breaks.\n\n - spaces, indention, line breaks and tokens.\n\n\n\n``` r\nugly_code <- \"a=function( x){1+1} \"\nstyle_text(ugly_code, scope = \"spaces\")\n#> a = function(x) {1 + 1}\n```\n\nNote that compared to the default used above `scope = \"tokens\"`:\n\n - no line breaks were added.\n\n - `<-` was not replaced with `=`.\n\nWhile spaces still got styled (around `=` in `(x)`).\n\nThis was just the tip of the iceberg. To learn more about customization\noptions with the tidyverse style guide, see the [help file for\n\\`tidyverse\\_style](https://styler.r-lib.org/reference/tidyverse_style.html)\nfor a quick overview or the [introductory\nvignette](https://styler.r-lib.org/articles/introducing_styler.html).\n\n## Features\n\n - style roxygen2 code examples.\n\n - do not re-style [deliberate code\n alignment](https://styler.r-lib.org/articles/detect-alignment.html).\n\n - [ignore some\n lines](https://styler.r-lib.org/dev/reference/stylerignore.html) for\n styling.\n\n - [cache styled\n expressions](https://styler.r-lib.org/dev/reference/caching.html)\n for speed.\n\n## Adaption of styler\n\nstyler functionality is made available through other tools, most notably\n\n - as a pre-commit hook `style-files` in\n \n\n - `usethis::use_tidy_style()` styles your project according to the\n tidyverse style guide.\n\n - via commenting a PR on GitHub with `\\style` when the [GitHub\n Action](https://github.com/features/actions) [*Tidyverse\n CI*](https://github.com/r-lib/actions/tree/master/examples#tidyverse-ci-workflow)\n is used. The most convenient way to set this up is via\n [`usethis::use_github_actions_tidy()`](https://usethis.r-lib.org/reference/github_actions.html?q=ghactions#use-github-actions-tidy-).\n\n - `reprex::reprex(style = TRUE)` to prettify reprex code before\n printing. To permanently use `style = TRUE` without specifying it\n every time, you can add the following line to your `.Rprofile` (via\n `usethis::edit_r_profile()`): `options(reprex.styler = TRUE)`.\n\n - you can pretty-print your R code in RMarkdown reports without having\n styler modifying the source. This feature is implemented as a code\n chunk option in knitr. use `tidy = \"styler\"` in the header of a code\n chunks (e.g. ` ```{r name-of-the-chunk, tidy = \"styler\"}`), or\n `knitr::opts_chunk$set(tidy = \"styler\")` at the top of your\n RMarkdown script.\n\n - Adding styler as a fixer to the [ale\n Plug-in](https://github.com/w0rp/ale/pull/2401#issuecomment-485942966)\n for VIM.\n\n - pretty-printing of [drake](https://github.com/ropensci/drake)\n workflow data frames with `drake::drake_plan_source()`.\n\n - Adding styler with\n [emacs-format-all-the-code](https://github.com/lassik/emacs-format-all-the-code)\n for Emacs.\n\n## Further resources\n\n - The official [web documentation](https://styler.r-lib.org/) of\n styler, containing various vignettes function documentation as well\n as a change-log.\n\n - [Blog\n post](https://lorenzwalthert.netlify.com/post/customizing-styler-the-quick-way/)\n about how you can customize styler without being an expert.\n\n - A [tidyverse.org blog\n post](https://www.tidyverse.org/articles/2017/12/styler-1.0.0/)\n introducing the functionality of styler and a [follow-up\n post](https://www.tidyverse.org/blog/2019/11/styler-1-2-0/) that\n introduces the new features since release 1.0.0.\n\n - The wiki of [Google Summer of Code\n 2017](https://github.com/rstats-gsoc/gsoc2017/wiki/Noninvasive-source-code-formatting)\n or the [pkgdown](https://r-lib.github.io/styler/) page contain\n information related to the initial development phase during Google\n Summer of Code 2017.","jobInfo":{"package":"styler","version":"1.3.0","parsingStatus":"success","parserVersion":1,"parsedAt":"2020-02-13T18:30:07+0000"}}

Description

Usage

Arguments

Details