README.Rmd

---
output: github_document
---

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

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

# audit.connect

<!-- badges: start -->
[![R-CMD-check](https://github.com/jumpingrivers/audit.workbench/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jumpingrivers/audit.workbench/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

This checks that Posit Workbench has been correctly installed.

## Installation

To install the R package, run

```{r, eval = FALSE}
install.packages('audit.workbench', 
                 repos = c('https://jumpingrivers.r-universe.dev', 
                           'https://cloud.r-project.org'))
```

## Usage

Running the test is straightforward

```{r, eval = FALSE}
library("audit.workbench")
check(server = "https://www.server.name/")
```