The goal of dora is to make it easy to calculate the DORA metrics from your existing development tooling and data.
The DORA metrics are 1. Change Lead Time 2. Deployment Frequency 3. Mean Time to Recovery 4. Change Failure Rate
Installation
You can install the development version of dora like so:
remotes::install_github("statik/dora")
Example
This is a basic example which shows you how to solve a common problem:
#library(dora)
## basic example code
What is special about using README.Rmd
instead of just README.md
? You can include R chunks like so:
summary(cars)
#> speed dist
#> Min. : 4.0 Min. : 2.00
#> 1st Qu.:12.0 1st Qu.: 26.00
#> Median :15.0 Median : 36.00
#> Mean :15.4 Mean : 42.98
#> 3rd Qu.:19.0 3rd Qu.: 56.00
#> Max. :25.0 Max. :120.00
A change.
You’ll still need to render README.Rmd
regularly, to keep README.md
up-to-date. devtools::build_readme()
is handy for this. You could also use GitHub Actions to re-render README.Rmd
every time you push. An example workflow can be found here: https://github.com/r-lib/actions/tree/v1/examples.
You can also embed plots, for example:
In that case, don’t forget to commit and push the resulting figure files, so they display on GitHub and CRAN.