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

# histoc <img src="man/figures/logo.png" height="100" width="100" align="left"/>


<!-- badges: start -->
[![R-CMD-check](https://github.com/txopen/histoc/workflows/R-CMD-check/badge.svg)](https://github.com/txopen/histoc/actions)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Last Commit Date](https://img.shields.io/github/last-commit/txopen/histoc.svg)](https://github.com/txopen/histoc/commits/main)
[![](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Codecov test coverage](https://codecov.io/gh/txopen/histoc/branch/main/graph/badge.svg)](https://app.codecov.io/gh/txopen/histoc?branch=main)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7338242.svg)](https://doi.org/10.5281/zenodo.7338242)
[![status](https://joss.theoj.org/papers/1913c20af5e50aa41711781623339c90/status.svg)](https://joss.theoj.org/papers/1913c20af5e50aa41711781623339c90)
<!-- badges: end -->

`histoc` is a package for histocompatibility analysis performed on kidney transplantation in allocation systems. 
A description of how to use it can be found [here](https://txopen.github.io/histoc/).

`histoc` provides functions to test compatibility between organ donors and transplant candidates, allowing to simulate different kidney transplant allocation systems.

> :warning: This package is not a medical device and <ins>should not be used for clinical decision-making</ins>.

## Installation

### Development version 

The development version can be installed from GitHub. Alongside the latest features you might also get a couple of bugs:exclamation:  

```
# install from GitHub
devtools::install_github("txopen/histoc")
```

## Bug reports and contributions

Reports on any bug encountered or any request for a new feature, are welcomed with a minimal reproducible example of your R code through the link: [report a bug](https://github.com/txopen/histoc/issues).