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%"
)
options(tibble.print_min = 5, tibble.print_max = 5)
```

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

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/bupaR)](https://CRAN.R-project.org/package=bupaR/)
[![GitHub version](https://img.shields.io/badge/GitHub-0.5.2-blue)](https://github.com/bupaverse/bupaR)
[![R-CMD-check](https://github.com/bupaverse/bupaR/workflows/R-CMD-check/badge.svg/)](https://github.com/bupaverse/bupaR/actions/)
[![codecov](https://codecov.io/gh/bupaverse/bupaR/branch/dev/graph/badge.svg?token=40OgWBneWv/)](https://app.codecov.io/gh/bupaverse/bupaR/)
[![Lifecycle: stable](https://lifecycle.r-lib.org/articles/figures/lifecycle-stable.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable/)
<!-- badges: end -->

**bupaR** is an open-source suite for the handling and analysis of business process data in [`R`](https://www.r-project.org/) developed by the Business Informatics research group at Hasselt University, Belgium. It builds upon the concept of an event log which is a logbook of events which have happened and were recorded within the execution of a business process.

[Read more](https://bupar.net/)

## Installation

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

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

### Development Version

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

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

## Cheat Sheet

<a href="https://bupar.net/materials/20170904%20poster%20bupaR.pdf"><img src="https://bupar.net/images/poster.PNG" width="630" height="443"/></a>

## Example

The [bupaR Documentation](https://bupar.net/getting_started.html) website contains more details on getting started with _Business Process Analysis_ using **bupaR**.

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

# Get a list of all cases in the patients event log:
patients %>%
  cases()
```