README.Rmd

---
output: 
    github_document:
      html_preview: false
---

<!-- 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%"
)
```

# mikRopML

> meek-ROPE em el

<!-- badges: start -->
[![build](https://github.com/SchlossLab/mikRopML/workflows/build/badge.svg)](https://github.com/SchlossLab/mikRopML/actions)
[![docs](https://img.shields.io/badge/docs-here-brightgreen)](https://schlosslab.org/mikRopML/)
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
<!-- badges: end -->

TODO: short description of what it does & why

## Installation

You can install the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("SchlossLab/mikRopML")
```

## Example

TODO

## Test coverage

```{r, include=FALSE}
# Inspired by https://github.com/r-lib/covr/issues/207
library(dplyr)
covr_report <- readRDS("covr_report.Rds")
cov_tally <- covr::tally_coverage(covr_report, by="line")
cov_summary <- cov_tally %>%
    group_by(filename) %>%
    summarize(coverage = round(sum(value) / n() * 100, 1))
overall_cov <- round(covr::percent_coverage(covr_report), 1)
```
**Overall: `r overall_cov`%**

```{r, echo=FALSE}
knitr::kable(cov_summary)
```