Skip to content
Snippets Groups Projects
Commit ef2a1813 authored by B.Anderson's avatar B.Anderson
Browse files

added style guide

parent 9cc8390c
Branches
Tags
No related merge requests found
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
There are as many templates for (R) repos as there R users... Here's ours. There are as many templates for (R) repos as there R users... Here's ours.
### Structure
We structure the repo as a package. We may never build it but usually we do so that the package functions are available everywhere in it We structure the repo as a package. We may never build it but usually we do so that the package functions are available everywhere in it
Things you should touch: Things you should touch:
...@@ -35,3 +37,9 @@ Things you should not touch: ...@@ -35,3 +37,9 @@ Things you should not touch:
| **man/** | Created by building the project/package using roxygen2 | | **man/** | Created by building the project/package using roxygen2 |
| **NAMESPACE** | - ditto - | | **NAMESPACE** | - ditto - |
| **.Rbuildignore** | - ditto - | | **.Rbuildignore** | - ditto - |
### Our coding habits
We try to remember to call functions using `woRkflow::myFunction()` so we know exactly which package we are using. This also forces regular package re-builds so your new fancy updated function can be used.
We defer to the [tidyverse style guide](https://style.tidyverse.org/) on many things although we do prefer using `camelCase` rather than `inserting_hyphens` in function and variable names.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment