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 = "#>"
)
```

# iNZight Addons

Below is a list of available addons for iNZight.

```{r, echo = FALSE}
index <- yaml::read_yaml("modules.yml")
tbl <- lapply(index, \(x) {
  data.frame(
    Name = x$title,
    Version = numeric_version(x$latest),
    Description = x$description,
    Author = x$author
  )
})
tbl <- do.call(rbind, tbl)
MIN_VERSION <- ifelse(Sys.getenv("GITHUB_REF") == "refs/heads/master", 1, 0)
tbl <- tbl[tbl$Version >= numeric_version(MIN_VERSION), ]
tbl$Version <- as.character(tbl$Version)
if (nrow(tbl)) {
  # write.dcf(tbl, "addons.txt")
  knitr::kable(tbl, row.names = FALSE)
} else {
  # cat("", file = "addons.txt")
  cat("No addons are currently available.\n")
}
```

<!--
BRANCH: `r Sys.getenv("GITHUB_REF")`
MINVERSION: `r MIN_VERSION`
-->

To install, download the file and install it from within iNZight:

- Open the **Modules** menu
- Choose **Manage ...**
- Click the **Browse** button to locate the addon file
- Click **Install**

You can also **remove modules** from **Manage modules**.

## Manual installation

To install addons manually, simply download the raw R file
and place it in your modules folder:

- Windows: `My Documents\iNZightVIT\modules`
- macOS: `Documents/iNZightVIT/modules`
- Linux: probably `~/Documents/iNZightVIT/modules`

## Making your own

To make your own, check out [the demo](https://github.com/iNZightVIT/demo-module.git).