probably v0.0.1

0

Monthly downloads

0th

Percentile

Tools for Post-Processing Class Probability Estimates

Models can be improved by post-processing class probabilities, by: recalibration, conversion to hard probabilities, assessment of equivocal zones, and other activities. 'probably' contains tools for conducting these operations.

Readme

probably

Travis build
status Codecov test
coverage Lifecycle:
experimental

Introduction

probably contains tools to facilitate activities such as:

  • Conversion of probabilities to discrete class predictions.

  • Investigating and estimating optimal probability thresholds.

  • Inclusion of equivocal zones where the probabilities are too uncertain to report a prediction.

Installation

You can install probably from CRAN with:

install.packages("probably")

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

devtools::install_github("topepo/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.

Functions in probably

Name Description
reexports Objects exported from other packages
probably-package probably: Tools for Post-Processing Class Probability Estimates
class_pred Create a class prediction object
is_class_pred Test if an object inherits from class_pred
levels.class_pred Extract class_pred levels
vec_type2.class_pred Find the common type for a class_pred and another object
locate-equivocal Locate equivocal values
vec_proxy_equal.class_pred Equality for class_pred
segment_naive_bayes Image segmentation predictions
species_probs Predictions on animal species
append_class_pred Add a class_pred column
as_class_pred Coerce to a class_pred object
threshold_perf Generate performance metrics across probability thresholds
vec_cast.class_pred Cast a class_pred vector to a specified type
make_class_pred Create a class_pred vector from class probabilities
reportable_rate Calculate the reportable rate
No Results!

Vignettes of probably

Name
equivocal-zones.Rmd
where-to-use.Rmd
No Results!

Last month downloads

Details

URL https://github.com/tidymodels/probably/
BugReports https://github.com/tidymodels/probably/issues
License GPL-2
Encoding UTF-8
LazyData true
ByteCompile true
RoxygenNote 6.1.0.9000
VignetteBuilder knitr
NeedsCompilation no
Packaged 2018-12-09 22:00:37 UTC; davis
Repository CRAN
Date/Publication 2018-12-18 16:40:05 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/probably)](http://www.rdocumentation.org/packages/probably)