{"Package":"styler","Title":"Non-Invasive Pretty Printing of R Code","Version":"1.1.0","Date":"2018-11-20","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\nuser's formatting intent.","License":"GPL-3","URL":"https://github.com/r-lib/styler","BugReports":"https://github.com/r-lib/styler/issues","Imports":"backports, cli, magrittr, purrr (>= 0.2.3), rematch2, rlang,\nrprojroot, tibble (>= 1.4.2), tools, withr, xfun","Suggests":"data.tree, dplyr, here, knitr, prettycode, rmarkdown,\nrstudioapi, testthat","VignetteBuilder":"knitr","Encoding":"UTF-8","LazyData":"true","RoxygenNote":"6.1.1","Collate":"'addins.R' 'communicate.R' 'compat-dplyr.R' 'compat-tidyr.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' 'testing.R'\n'token-create.R' 'transform-code.R' 'transform-files.R' 'ui.R'\n'unindent.R' 'utils.R' 'vertical.R' 'visit.R' 'zzz.R'","NeedsCompilation":"no","Packaged":"2018-11-20 16:11:24 UTC; lorenz","Author":"Kirill Mller [aut],\nLorenz Walthert [cre, aut]","Maintainer":"Lorenz Walthert ","Repository":"CRAN","Date/Publication":"2018-11-20 16:40:03 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/styler_1.1.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\nThe goal of styler is to provide non-invasive pretty-printing of R\nsource code while adhering to the\n[tidyverse](http://style.tidyverse.org) formatting rules. styler can be\ncustomized to format code according to other style guides too.\n\n## Installation\n\nYou can install the package from CRAN:\n\n``` r\ninstall.packages(\"styler\") \n```\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 and/or .Rmd files.\n - `style_dir()` styles all .R and/or .Rmd files in a directory.\n - `style_pkg()` styles the source files of an R package.\n - RStudio Addins for styling the active file, styling the current\n package and styling the highlighted code\nregion.\n\n

\n\n## Functionality of styler\n\n**scope**\n\nYou can decide on the level of invasiveness with the scope argument. You\ncan style:\n\n - just spaces.\n - spaces and indention.\n - spaces, indention and line breaks.\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 - `<-` was not replaced with `=`.\n\nWhile spaces still got styled (around `=` in `(x)`).\n\n**strict**\n\nIf you wish to keep alignment as is, you can use `strict = FALSE`:\n\n``` r\nstyle_text(\n c(\n \"first <- 4\", \n \"second <- 1+1\"\n ),\n strict = FALSE \n) \n#> first <- 4\n#> second <- 1 + 1\n```\n\nThis was just the tip of the iceberg. Learn more about customization\nwith the tidyverse style guide in in this\n[vignette](http://styler.r-lib.org/articles/introducing_styler.html). If\nthis is not flexible enough for you, you can implement your own style\nguide, as explained in the corresponding\n[vignette](http://styler.r-lib.org/articles/customizing_styler.html).\n\n## Adaption of styler\n\nstyler functionality is made available through other packages, most\nnotably\n\n - `usethis::use_tidy_style()` styles your project according to the\n tidyverse style guide.\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 - 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 - pretty-printing of [drake](https://github.com/ropensci/drake)\n workflow data frames with `drake::drake_plan_source()`.\n\n## Further resources\n\n - The official [web documentation](http://styler.r-lib.org/) of\n styler, containing various vignettes function documentation as well\n as a change-log.\n - [Blog\n post](https://lorenzwalthert.netlify.com/posts/customizing-styler-the-quick-way/)\n about how you can customize styler without being an expert.\n - A [tidyverse.org blog\n post](https://www.tidyverse.org/articles/2017/12/styler-1.0.0/)\n introducing the functionality of styler.\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.1.0","parsingStatus":"success","parserVersion":1,"parsedAt":"2019-05-07T00:29:47+0000"}}

Description

Usage

Arguments

Details