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%"
)
```

# hubUtils <a href="https://hubverse-org.github.io/hubUtils/"><img src="man/figures/logo.png" align="right" height="131" alt="hubUtils website" /></a>

<!-- badges: start -->

[![R-CMD-check](https://github.com/hubverse-org/hubUtils/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/hubverse-org/hubUtils/actions/workflows/R-CMD-check.yaml)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Codecov test coverage](https://codecov.io/gh/hubverse-org/hubUtils/branch/main/graph/badge.svg)](https://app.codecov.io/gh/hubverse-org/hubUtils?branch=main)
[![CRAN status](https://www.r-pkg.org/badges/version/hubUtils)](https://CRAN.R-project.org/package=hubUtils)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->

The goal of `hubUtils` is to provide a core set of low-level utility functions common across the hubverse. Functions are used to interact with hubverse schema, hub config files and model outputs and are designed to be primarily used internally by other hubverse packages.

## Installation

You can install the released version of `hubUtils` from [CRAN](https://CRAN.R-project.org) with:

```r
install.packages("hubUtils")
```

### Latest

You can install the [latest version of hubUtils from the R-universe](https://hubverse-org.r-universe.dev/hubUtils):

```r
install.packages("hubUtils", repos = c("https://hubverse-org.r-universe.dev", "https://cloud.r-project.org"))
```

### Development

If you want to test out new features that have not yet been released, you can install the development version of hubUtils from [GitHub](https://github.com/) with:

```r
remotes::install_github("hubverse-org/hubUtils")
```

***

## Code of Conduct

Please note that the hubUtils package is released with a [Contributor Code of Conduct](https://hubverse-org.github.io/hubUtils/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

## Contributing

Interested in contributing back to the open-source hubverse project?
Learn more about how to [get involved in the Hubverse Community](https://hubverse.io/en/latest/overview/contribute.html) or [how to contribute to the hubUtils package](https://hubverse-org.github.io/hubUtils/CONTRIBUTING.html).