README.Rmd

---
  output: github_document
---
  
  ```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# rRACES <a href="caravagnalab.github.io/rRACES"><img src="man/figures/logo.png" align="right" height="120" alt="" /></a>


<!-- badges: start -->
<!--  
  [![R-CMD-check](https://github.com/caravagnalab/rRACES/workflows/R-CMD-check/badge.svg)](https://github.com/caravagnalab/rRACES/actions)
[![pkgdown](https://github.com/caravagnalab/rRACES/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/caravagnalab/rRACES/actions/workflows/pkgdown.yaml)
-->
<!-- badges: end -->
  
`rRACES` is an R Wrapper for [RACES](https://github.com/albertocasagrande/RACES/), a C++ tumour evolution simulator.

#### Help and support

[![](https://img.shields.io/badge/GitHub%20Pages-https://caravagnalab.github.io/rRACES/-yellow.svg)](https://caravagnalab.github.io/rRACES/)
-----

### Installation

In order to install the development version of `rRACES`, you need:

* [R and Rtools](https://cran.r-project.org).

* the R package [`devtools`](https://devtools.r-lib.org).

* [git](https://git-scm.com/downloads).


When the requirements have been satisfied, issue the R command:

``` r
devtools::install_github("caravagnalab/rRACES")
```

Tissue plotting requires the R package 
[`hexbin`](https://cran.r-project.org/web/packages/hexbin/index.html)
under GNU/Linux and Windows.

-----
  
#### Copyright and contacts
  
Giulio Caravagna, Alberto Casagrande. Cancer Data Science (CDS) Laboratory.

[![](https://img.shields.io/badge/CDS%20Lab%20Github-caravagnalab-seagreen.svg)](https://github.com/caravagnalab/)
[![](https://img.shields.io/badge/CDS%20Lab%20webpage-https://www.caravagnalab.org/-red.svg)](https://www.caravagnalab.org/)