Skip to content

Commit

Permalink
Add section on coding style
Browse files Browse the repository at this point in the history
  • Loading branch information
milanmlft committed Aug 12, 2024
1 parent 1648027 commit 3ce729d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,22 @@ The filenames in `R/` follow the [`{golem}` conventions](https://engineering-shi
An overview of the app's design is given in the diagram below (note that this is subject to change):

![](./dev/design/omop-data-catalogue-design.png)

### Coding style

We'll mainly follow the [tidyverse style guide](https://style.tidyverse.org/).
The [`{styler}`](https://styler.r-lib.org/index.html) package can be used to automatically format R code to this style,
by regularly running
```r
styler::style_pkg()
```
within the project directory.
It's also recommended to install [`{lintr}`](https://github.com/r-lib/lintr) and regularly run

```r
lintr::lint_package()
```

(or have it [run automatically in your IDE](https://lintr.r-lib.org/articles/editors.html)).

0 comments on commit 3ce729d

Please sign in to comment.