---
title: "mlstrOpalr-vignette"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{mlstrOpalr-vignette}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

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

# mlstrOpalr

Functions to support compatibility between Maelstrom R packages and Opal 
environment. Opal is the OBiBa application for data management, and Opal 
environments can be integrated with RStudio environments using the package 
`opalr`. The user must have adequate credentials to interact with a specific 
Opal environment. 
Please see [Opal documentation](https://opaldoc.obiba.org/) for complete 
documentation.

# Get started

## Install the package

```{r, eval=FALSE}
# To update the R package in your R environment you may first need to remove 
# it, and use the exit command quit() to terminate the current R session.

# To install the R package:
install.packages('mlstrOpalr')
library(mlstrOpalr) 

#if you need help with the package, please use:
mlstrOpalr_help()

```
