vimc-rpkg-template.Rmd

---
title: "vimc-rpkg-template"
output: rmarkdown::html_vignette
# NOTE: make references if any available as a JSON at a location, see e.g. below
# NOTE: uncomment the line below, and update the references path as needed
# bibliography: resources/references.json
vignette: >
  %\VignetteIndexEntry{vimc-rpkg-template}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

```{r setup}
library(vimc.rpkg.template)
```

This is a special vignette, which shares the same name as the package.
It will render as the "Get started" page in the navigation bar of _pkgdown_ websites.

To develop it further:

1. Rename the file to your package name;

2. Add code and explainers to help users get started with using your package in this vignette;

3. Remember to add and link references if needed.

## References