README.Rmd

---
output: github_document
editor_options: 
  chunk_output_type: console
---

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

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

# probably <a href="https://probably.tidymodels.org"><img src="man/figures/logo.png" align="right" height="138" alt="probably website" /></a>

<!-- badges: start -->
[![Codecov test coverage](https://codecov.io/gh/tidymodels/probably/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/probably?branch=main)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![R-CMD-check](https://github.com/tidymodels/probably/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/probably/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

## Introduction

probably contains tools to facilitate activities such as:

* Conversion of probabilities to discrete class predictions.

* Investigating and estimating optimal probability thresholds.

* Calibration assessments and remediation for classification and regression models.

* Inclusion of _equivocal zones_ where the probabilities are too uncertain to report a prediction.

## Installation

You can install probably from CRAN with:

```{r, eval = FALSE}
install.packages("probably")
```

You can install the development version of probably from GitHub with:

```{r, eval = FALSE}
# install.packages("pak")
pak::pak("tidymodels/probably")
```

## Examples

Good places to look for examples of using probably are the vignettes.

* `vignette("equivocal-zones", "probably")` discusses the new `class_pred` class that probably provides for working with equivocal zones.

* `vignette("where-to-use", "probably")` discusses how probably fits in with the rest of the tidymodels ecosystem, and provides an example of optimizing class probability thresholds.

## Contributing

This project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

- For questions and discussions about tidymodels packages, modeling, and machine learning, please [post on RStudio Community](https://community.rstudio.com/new-topic?category_id=15&tags=tidymodels,question).

- If you think you have encountered a bug, please [submit an issue](https://github.com/tidymodels/probably/issues).

- Either way, learn how to create and share a [reprex](https://reprex.tidyverse.org/articles/articles/learn-reprex.html) (a minimal, reproducible example), to clearly communicate about your code.

- Check out further details on [contributing guidelines for tidymodels packages](https://www.tidymodels.org/contribute/) and [how to get help](https://www.tidymodels.org/help/).