Skip to content

Commit

Permalink
Add section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Serene-Arc committed Apr 11, 2024
1 parent 0fb521e commit 15b20f8
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,20 @@ to

[![R source code after
reformatting](https://db.yihui.org/imgur/TBZm0B8.png)](https://yihui.shinyapps.io/formatR/)

## Pre-commit Hook

formatR is available as a pre-commit hook. The following arguments are available:

```
Options:
--no-comments Remove comments.
--no-blanks Remove blank lines.
--arrow If given, arrows will not be substituted for = signs.
--pipe If given, pipes will not be changed.
--brace-newline If given, braces will not be put on new lines.
--indent=INDENT Number of indents. [default: 4]
--no-wrap Skip wrapping the text.
--width-cutoff=WIDTH Text width cutoff. [default: 80]
--args-newline If TRUE, arguments are started on a new line after a function call. [default: FALSE]
```

0 comments on commit 15b20f8

Please sign in to comment.