README.Rmd

---
output: github_document
---

# wqbenchdata

<!-- badges: start -->
[![img](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
[![R-CMD-check](https://github.com/bcgov/wqbenchdata/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/bcgov/wqbenchdata/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

This package contains sample data and test data for the `wqbench` suite of tools.

## Installation

```{r, eval=FALSE}
# install.packages("remotes")
remotes::install_github("bcgov/wqbenchdata")
```

## Usage

```{r}
library(wqbenchdata)
```

Use the sample data set called `aquatic_data` which contains 100 rows.

```{r, rows.print = 10}
str(aquatic_data)
```

## Getting Help or Reporting an Issue

To report issues, bugs or enhancements, please file an [issue](https://github.com/bcgov/wqbenchdata/issues). 
Check out the [support](https://github.com/bcgov/wqbenchdata/blob/main/.github/SUPPORT.md) for more info. 

## Code of Conduct

Please note that the shinywqbench project is released with a [Contributor Code of Conduct](https://github.com/bcgov/wqbenchdata/CODE_OF_CONDUCT.md). 
By contributing to this project, you agree to abide by its terms.

## License 

The code is released under the Apache License 2.0

> Copyright 2023 Province of British Columbia
> 
> Licensed under the Apache License, Version 2.0 (the "License");
> you may not use this file except in compliance with the License.
> You may obtain a copy of the License at 
> 
> https://www.apache.org/licenses/LICENSE-2.0
> 
> Unless required by applicable law or agreed to in writing, software
> distributed under the License is distributed on an "AS IS" BASIS,
> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
> See the License for the specific language governing permissions and
> limitations under the License.