README.Rmd

---
output: github_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(message = FALSE, warning = FALSE)
```

# metaMapWidget: R Wrapper for the meta-map-widget Leaflet widget

This package allows users to view the locations of custom data samples and their various attributes using an interactive map widget. The widget may be embedded in Rmd/Quarto documents.

## Installation

For now, metaMapWidgetR is only available on Github and can be installed with devtools:

```{r eval=FALSE}
devtools::install_github('grunwaldlab/metaMapWidgetR')
```

## Quickstart and Basic Usage
```{r child='vignettes/articles/quickstart.Rmd'}
```

The map render function requires an input data set (either a TSV or dataframe), but extra parameters are optional.