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

# SimuNet

<!-- badges: start -->
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5517582.svg)](https://doi.org/10.5281/zenodo.5517582)
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![R-CMD-check](https://github.com/R-KenK/SimuNet/workflows/R-CMD-check/badge.svg)](https://github.com/R-KenK/SimuNet/actions)
[![CRAN status](https://www.r-pkg.org/badges/version/SimuNet)](https://CRAN.R-project.org/package=SimuNet)
<!-- badges: end -->

A network simulation framework, with a zest of empiricism

## Installation
SimuNet, as a young and starting package, is not on CRAN.

You can install the latest version of SimuNet from GitHub using different packages:

### Using `renv`
To install, run in R:
```
renv::install("R-KenK/SimuNet")
```

### Using `remotes`
To install, run in R:
```
remotes::install_github("R-KenK/SimuNet")
```

### Using `devtools`
Be sure to have [Rtools](https://cran.r-project.org/bin/windows/Rtools/) installed.
To install, simply run in R:
```
install.packages("devtools")
devtools::install_github("R-KenK/SimuNet")
```