
<!-- README.md is generated from README.Rmd. Please edit that file -->

# mlstrOpalr

<!-- badges: start -->

[![R-CMD-check](https://github.com/maelstrom-research/mlstrOpalr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/maelstrom-research/mlstrOpalr/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

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
# 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()
```
