Skip to content

Commit

Permalink
Add codecov and automatic pkgdown deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
DavisVaughan committed Oct 15, 2018
1 parent 90a83f0 commit f401b20
Show file tree
Hide file tree
Showing 8 changed files with 136 additions and 13 deletions.
4 changes: 4 additions & 0 deletions .Rbuildignore
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$
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
.Rhistory
.RData
.DS_Store
docs
23 changes: 17 additions & 6 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,24 @@ language: R
sudo: false
cache: packages

r:
- devel
- release
- oldrel
- 3.2
- 3.1
r_github_packages:
- tidyverse/tidytemplate

matrix:
include:
- r: devel
- r: release
after_success:
- Rscript -e 'covr::codecov()'

deploy:
provider: script
script: Rscript -e 'pkgdown::deploy_site_github(verbose = TRUE)'
skip-cleanup: true
on:
all_branches: true
- r: oldrel
- r: 3.2
- r: 3.1
allow_failures:
- r: 3.1
7 changes: 5 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,11 @@ Imports:
vctrs,
yardstick
Suggests:
testthat
testthat,
covr,
pkgdown
Remotes:
r-lib/vctrs,
r-lib/generics,
tidymodels/yardstick
tidymodels/yardstick,
r-lib/pkgdown
38 changes: 38 additions & 0 deletions README.Rmd
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")
```
32 changes: 27 additions & 5 deletions README.md
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")
```
32 changes: 32 additions & 0 deletions _pkgdown.yml
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
12 changes: 12 additions & 0 deletions codecov.yml
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%

0 comments on commit f401b20

Please sign in to comment.