README.Rmd

---
output: github_document
---

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

# edeaR <a href="https://bupaverse.github.io/edeaR/"><img src="man/figures/logo.png" align="right" height="50" /></a>

<!-- badges: start -->
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/edeaR)](https://cran.r-project.org/package=edeaR)
[![GitHub version](https://img.shields.io/badge/GitHub-0.9.2-blue)](https://github.com/bupaverse/edeaR)
[![R-CMD-check](https://github.com/bupaverse/edeaR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/bupaverse/edeaR/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/bupaverse/edeaR/branch/master/graph/badge.svg)](https://app.codecov.io/gh/bupaverse/edeaR?branch=master)
[![Lifecycle: stable](https://lifecycle.r-lib.org/articles/figures/lifecycle-stable.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable/)
<!-- badges: end -->

This package provides several useful techniques for _Exploratory and Descriptive Analysis_ of event based data in [`R`](https://www.r-project.org/).

For more information, check the [manual on GitHub](https://bupaverse.github.io/edeaR/) or the [bupaR Documentation](https://bupaverse.github.io/docs/) website.

## Installation

You can install **edeaR** from [CRAN](https://cran.r-project.org/) with:

```{r cran-installation, eval = FALSE}
install.packages("edeaR")
```

### Development Version

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

```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("bupaverse/edeaR")
```

## Example

```{r example}
library(edeaR)
library(eventdataR)

# Calculate idle times per resource:
patients %>%
  idle_time(level = "resource", units = "days")
```