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%"
)
```
<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![CodeFactor](https://www.codefactor.io/repository/github/roblbaker/qckit/badge)](https://www.codefactor.io/repository/github/roblbaker/qckit)
[![R-CMD-check](https://github.com/nationalparkservice/QCkit/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/nationalparkservice/QCkit/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

# QCkit

QCkit is a collection of quality control functions to munge, check, flag, correct, and summarize data collected by the U.S. National Park Service Inventory & Monitoring Division. These functions will be particularly useful in preparing data for metadata creation and in writing Data Release Reports, but may include aspects that are more widely applicable outside the National Park Service (such as converting UTMs to Latitude and Longitude).

Functions are typically user generated and so may not have been thoroughly tested for all use cases.

If you would like to contribute useful functions please initiate a pull request.

Please request enhancements and bug fixes through [Issues](https://github.com/nationalparkservice/QCkit/issues).

# Installation 

Stand-alone installation:
``` r
# install.packages("devtools")
devtools::install_github("nationalparkservice/QCkit")
library(QCkit)
```

QCkit is also part of the [NPSdataverse](https://nationalparkservice.github.io/NPSdataverse/) and can be installed along with the other components of NPSdataverse:

```r
# install.packages("devtools")
devtools::install_github("nationalparkservice/NPSdataverse")
library(NPSdataverse)
```