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

# modelgraph

<!-- badges: start -->
<!-- badges: end -->

An R interface for the `tikz` LaTeX package for making compartmental model flow diagrams

Éric Marty

`modelgraph` is designed to produce flow diagrams for compartmental models, stored as LaTeX code.

As such, `modelgraph` works most seamlessly within an Rmarkdown document with PDF output, where the stored LaTeX code can be embedded in the document directly. However, the LaTeX code can also be saved to a `.tex` file for inclusion elsewhere.

Here's an example of what is possible using `modelgraph`:

![](modelgraph_example.png)

## Installation

`modelgraph` is under active development. It will eventually be released as an R package. 
It is possible to use modelgraph in its current state. Please read `pre-release-introduction.Rmd` or `pre-release-introduction.pdf` for instructions.