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

# hubEnsembles <img src="man/figures/logo.png" align="right" height="131" alt="" />

<!-- badges: start -->

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/hubverse-org/hubEnsembles/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/hubverse-org/hubEnsembles/actions/workflows/R-CMD-check.yaml)
[![CRAN status](https://www.r-pkg.org/badges/version/hubEnsembles)](https://CRAN.R-project.org/package=hubEnsembles)
<!-- badges: end -->

The goal of hubEnsembles is to provide standard implementations of commonly used methods for ensembling model outputs. The hubEnsembles package is part of [the hubverse project](https://hubverse.io/en/latest/) and expects all input data to the key functions to be formatted as an object of a [`model_out_tbl` class](https://hubverse-org.github.io/hubUtils/reference/as_model_out_tbl.html).

## Installation

### Latest

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

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

### Development

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

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


***

## Code of Conduct

Please note that the hubEnsembles package is released with a [Contributor Code of Conduct](https://hubverse-org.github.io/hubEnsembles/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 hubEnsembles package](https://hubverse-org.github.io/hubEnsembles/CONTRIBUTING.html).