-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add codecov and automatic pkgdown deployment
- Loading branch information
1 parent
90a83f0
commit f401b20
Showing
8 changed files
with
136 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
^docs$ | ||
^_pkgdown\.yml$ | ||
^codecov\.yml$ | ||
^README\.Rmd$ | ||
^\.travis\.yml$ | ||
^probably\.Rproj$ | ||
^\.Rproj\.user$ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,3 +2,4 @@ | |
.Rhistory | ||
.RData | ||
.DS_Store | ||
docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
output: github_document | ||
--- | ||
|
||
<!-- 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 | ||
|
||
[![Travis build status](https://travis-ci.org/topepo/probably.svg?branch=master)](https://travis-ci.org/topepo/probably) | ||
[![Codecov test coverage](https://codecov.io/gh/topepo/probably/branch/master/graph/badge.svg)](https://codecov.io/gh/topepo/probably?branch=master) | ||
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental) | ||
|
||
## Introduction | ||
|
||
`probably` contains tools to facilitate activities such as: | ||
|
||
* exploration and visualization of class probability distributions, | ||
* conversion of probabilities to discrete class predictions, | ||
* investigate and estimate optimal probability thresholds, | ||
* inclusion of _equivocal zones_ where the probabilities are too uncertain to report a prediction, | ||
* recalibration of class probabilities. | ||
|
||
## Installation | ||
|
||
You can install `probably` from GitHub with: | ||
|
||
```{r, eval = FALSE} | ||
devtools::install_github("topepo/probably") | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,30 @@ | ||
|
||
<!-- README.md is generated from README.Rmd. Please edit that file --> | ||
|
||
# probably | ||
|
||
[![Travis build | ||
status](https://travis-ci.org/topepo/probably.svg?branch=master)](https://travis-ci.org/topepo/probably) | ||
[![Codecov test | ||
coverage](https://codecov.io/gh/topepo/probably/branch/master/graph/badge.svg)](https://codecov.io/gh/topepo/probably?branch=master) | ||
[![Lifecycle: | ||
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental) | ||
|
||
## Introduction | ||
|
||
`probably` contains tools to facilitate activities such as: | ||
|
||
* exploration and visualization of class probability distributions, | ||
* conversion of probabilities to discrete class predictions, | ||
* investigate and estimate optimal probability thresholds, | ||
* inclusion of _equivocal zones_ where the probabilities are too uncertain to report a prediction, | ||
* recalibration of class probabilities. | ||
- exploration and visualization of class probability distributions, | ||
- conversion of probabilities to discrete class predictions, | ||
- investigate and estimate optimal probability thresholds, | ||
- inclusion of *equivocal zones* where the probabilities are too | ||
uncertain to report a prediction, | ||
- recalibration of class probabilities. | ||
|
||
## Installation | ||
|
||
You can install `probably` from GitHub with: | ||
|
||
``` r | ||
devtools::install_github("topepo/probably") | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
template: | ||
package: tidytemplate | ||
params: | ||
part_of: tidymodels | ||
footer: probably is a part of the tidymodels ecosystem, a collection of modeling packages designed with common APIs and a shared philosophy. | ||
|
||
development: | ||
mode: auto | ||
|
||
home: | ||
strip_header: true | ||
|
||
reference: | ||
- title: Class predictions | ||
contents: | ||
- class_pred | ||
- matches("_class_pred") | ||
- reportable_rate | ||
- threshold_perf | ||
- locate-equivocal | ||
- levels.class_pred | ||
|
||
- title: Vctrs compatibility | ||
contents: | ||
- vec_cast.class_pred | ||
- vec_type2.class_pred | ||
|
||
- title: Data | ||
contents: | ||
- segment_naive_bayes | ||
- segment_logistic | ||
- species_probs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
comment: false | ||
|
||
coverage: | ||
status: | ||
project: | ||
default: | ||
target: auto | ||
threshold: 1% | ||
patch: | ||
default: | ||
target: auto | ||
threshold: 1% |