README.Rmd

---
title: "DataSHIELD helper functions"
output: github_document
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

[![CRAN status](https://www.r-pkg.org/badges/version/dsHelper)](https://CRAN.R-project.org/package=dsHelper)
[![Codecov test coverage](https://codecov.io/gh/lifecycle-project/ds-helper/branch/master/graph/badge.svg)](https://app.codecov.io/gh/lifecycle-project/ds-helper?branch=master)
[![Build Status](https://dev.azure.com/sidohaakma/datashield-packages/_apis/build/status/lifecycle-project.ds-helper?branchName=master)](https://dev.azure.com/sidohaakma/datashield-packages/_apis/build/status/lifecycle-project.ds-helper?branchName=master)

This is a set of functions to help make data manipulation and analysis easier
within DataSHIELD.  

## Install

You can install the package by running the following command in R Studio:

First you need some prerequisites:

```R
install.packages("remotes")
library(remotes)
```

Now to install the package and use the package:

```R
install_github("lifecycle-project/ds-helper")
library(dsHelper)
```

## Development

If you find any bugs, would like to request additional functionality or have
written functions you would like to be included in the package please contact me 
at t.cadman@bristol.ac.uk. 

## Troubleshooting

Please check: [troubleshooting](https://lifecycle-project.github.io/ds-helper/)