robinlovelace / styler.equals

A style for equals assignment, based on the styler package

styler.equals

This package is based on https://github.com/lorenzwalthert/styler.yours

The goal of {styler.equals} is to provide an implementation of the ‘equals style’ used by Yuhei Xie, Colin Gillespie and many in the #rspatial community.

So far it basically just the ‘tidyverse style’ but with equals assignment. In the future it may evolve, e.g. to implement the Geocomputation with R style guide.

It is a third-party style guide for {styler}.

Installation

You can install the released version of {styler.equals} from GitHub with:

remotes::install_github("robinlovelace/styler.equals")

Example

This is a basic example of how to style code with it.

library(styler.equals)
cache_deactivate()
#> Deactivated cache.
text = "x <- 4
y = 3
a;
"

text_styled_equals = style_text(text)
text_styled_equals
#> x = 4
#> y = 3
#> a

A more complicated example showing that it also fixes other issues from the styler package is:

style_text("a=2", scope = "tokens")
#> a = 2
style_text("a=2", scope = I(c("tokens", "indention")))
#> a=2

style_text(
  "tibble::tibble(
     small  = 2 ,
     medium = 4,#comment without space
     large  = 6
   )"
)
#> tibble::tibble(
#>   small  = 2,
#>   medium = 4, # comment without space
#>   large  = 6
#> )

styler.equals's Issues

Release styler.equals 0.0.2

First release:

• usethis::use_cran_comments()
• Update (aspirational) install instructions in README
• Proofread Title: and Description:
• Check that all exported functions have @return and @examples
• Check that Authors@R: includes a copyright holder (role 'cph')
• Check licensing of included files
• Review https://github.com/DavisVaughan/extrachecks

Prepare for release:

• git pull
• devtools::build_readme()
• urlchecker::url_check()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• rhub::check_for_cran()
• git push

Submit to CRAN:

• usethis::use_version('patch')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• git push
• usethis::use_github_release()
• usethis::use_dev_version()
• usethis::use_news_md()
• git push

`styler.equals::style_pkg()` makes fewer corrections than `styler::style_pkg()`

From pola-rs/r-polars#214

Thanks for working on this.
I tried styler.equals::style_pkg() on the polars package, but it was necessary to run it after styler::style_pkg() because the modifications were not made as expected.
Are differences other than assign operators intentional?
Or do you plan to make all but the assignment operator equivalent to styler::style_pkg() in the future?

How to use as addin for Rstudio

Thank you so much for this package!!

I'm a bit confused by the several options R offers for styling/reformatting your code. Especially when looking at the amazing styler package I get a little bit lost when all I want to do is just change the <- for the =.

Anyways... I was wondering if there is any way (certainly there is as described here r-lib/styler#860 and here https://styler.r-lib.org/reference/styler_addins.html?q=addin ) to use this package here as the formatting option when using the addin from the styler packages. I'm not really understanding how to set the options in the .Rprofile file to make this work.

Especially this sentence:

"To use this style with the addin, you need to create an R package that exports this style guide, and then set the R option styler.addins_style_transformer as described here."
from here r-lib/styler#860 (comment) is confusing me

I tried the following in an .Rprofile file, but this is not right definitly...

library(styler.equals)

options(styler.save_after_styling = TRUE)
options(styler.addins_style_transformer = styler.equals::equals_style())

I'm sorry about any misunderstandings and really grateful for any advises.

Update authors

@lorenzwalthert do you want to be down as a contributor?