README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# styler.mlr

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/mlr-org/styler.mlr/workflows/R-CMD-check/badge.svg)](https://github.com/mlr-org/styler.mlr/actions)
<!-- badges: end -->

The goal of {styler.mlr} is format code according to the [mlr style](https://github.com/mlr-org/mlr3/wiki/Style-Guide). It is an example for a
custom [{styler}](https://styler.r-lib.org) style guide.

## Installation

You can install the released version of {styler.mlr} from [GitHub](https://github.com) with:

``` r
remotes::install_github("mlr-org/styler.mlr")
```

## Example

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

```{r example}
library(styler.mlr)
cache_deactivate()
text = "x <- 4
y = 3
a;
"

style_text(text)
```

To use the `mlr-style` in the RStudio addin, one can put something like this into `.Rprofile`:

```{r}
if (grepl("mlr", getwd()) || grepl("paradox", getwd())) {
  options(styler.addins_style_transformer = "styler.mlr::mlr_style()")
}
```