Skip to content

Commit

Permalink
merge pr #52: v0.1.0 on CRAN!
Browse files Browse the repository at this point in the history
  • Loading branch information
simonpcouch authored Nov 23, 2020
2 parents 7c81ea7 + b12c726 commit 95b4c4e
Show file tree
Hide file tree
Showing 9 changed files with 60 additions and 24 deletions.
4 changes: 3 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,6 @@ data-raw/
_pkgdown\.yml$
docs/
pkgdown/
tests/testthat/helper_data\.Rda$
tests/testthat/helper_data\.Rda$
cran-comments.md
^CRAN-RELEASE$
1 change: 1 addition & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ jobs:
- name: Install dependencies
run: |
remotes::install_cran("vctrs")
remotes::install_cran("tune")
remotes::install_deps(dependencies = TRUE)
remotes::install_cran("rcmdcheck")
shell: Rscript {0}
Expand Down
11 changes: 4 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: stacks
Title: Tidy Model Stacking
Version: 0.0.0.9000
Version: 0.1.0
Authors@R: c(
person(given = "Simon",
family = "Couch",
Expand All @@ -13,7 +13,7 @@ Authors@R: c(
person("RStudio",
role = "cph")
)
Description: Model stacking is an ensembling technique
Description: Model stacking is an ensemble technique
that involves training a model to combine the outputs of many
diverse statistical models, and has been shown to improve
predictive performance in a variety of settings. 'stacks'
Expand All @@ -22,14 +22,14 @@ License: MIT + file LICENSE
Depends:
R (>= 2.10)
Imports:
tune (>= 0.1.1),
tune (>= 0.1.2),
dplyr (>= 1.0.0),
rlang (>= 0.4.0),
tibble (>= 2.1.3),
purrr (>= 0.3.2),
parsnip (>= 0.0.4),
workflows (>= 0.1.0),
recipes,
recipes (>= 0.1.15),
yardstick,
tidyr,
dials,
Expand All @@ -54,9 +54,6 @@ Suggests:
ranger,
nnet,
kknn
Remotes:
tidymodels/tune,
tidymodels/recipes
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
Expand Down
5 changes: 5 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# stacks

### v 0.1.0

Initial release.
11 changes: 5 additions & 6 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ output: github_document
---

<!-- badges: start -->
[![R build status](https://github.com/simonpcouch/stacks/workflows/R-CMD-check/badge.svg)](https://github.com/simonpcouch/stacks/actions)
[![R build status](https://github.com/simonpcouch/stacks/workflows/R-CMD-check/badge.svg)](https://github.com/tidymodels/stacks/actions)
[![Codecov test coverage](https://codecov.io/gh/tidymodels/stacks/branch/main/graph/badge.svg)](https://codecov.io/gh/tidymodels/stacks?branch=main)
[![CRAN status](https://www.r-pkg.org/badges/version/stacks)](https://CRAN.R-project.org/package=stacks)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-blue.svg)](https://www.tidyverse.org/lifecycle/#experimental)
<!-- badges: end -->

```{r setup, include=FALSE}
Expand All @@ -19,7 +18,7 @@ stacks is an R package for model stacking that aligns with the tidymodels. Model

The process goes something like this:

1. Define candidate ensemble members using functionality from [rsample](https://rsample.tidymodels.org/), [parsnip](https://parsnip.tidymodels.org/), [workflows](https://workflows.tidymodels.org/), [recipes](https://recipes.tidymodels.org/), and [tune](http://tune.tidymodels.org/)
1. Define candidate ensemble members using functionality from [rsample](https://rsample.tidymodels.org/), [parsnip](https://parsnip.tidymodels.org/), [workflows](https://workflows.tidymodels.org/), [recipes](https://recipes.tidymodels.org/), and [tune](https://tune.tidymodels.org/)
2. Initialize a `data_stack` object with `stacks()`
3. Iteratively add candidate ensemble members to the `data_stack` with `add_candidates()`
4. Evaluate how to combine their predictions with `blend_predictions()`
Expand Down Expand Up @@ -64,13 +63,13 @@ The full visual outline for these steps can be found [here](https://github.com/t

## contributing

This project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
This project is released with a [Contributor Code of Conduct](https://github.com/tidymodels/stacks/blob/main/CODE_OF_CONDUCT.md). 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://rstd.io/tidymodels-community).
- 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/stacks/issues).

- Either way, learn how to create and share a [reprex](https://rstd.io/reprex) (a minimal, reproducible example), to clearly communicate about your code.
- 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/).

Expand Down
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@
<!-- badges: start -->

[![R build
status](https://github.com/simonpcouch/stacks/workflows/R-CMD-check/badge.svg)](https://github.com/simonpcouch/stacks/actions)
status](https://github.com/simonpcouch/stacks/workflows/R-CMD-check/badge.svg)](https://github.com/tidymodels/stacks/actions)
[![Codecov test
coverage](https://codecov.io/gh/tidymodels/stacks/branch/main/graph/badge.svg)](https://codecov.io/gh/tidymodels/stacks?branch=main)
[![CRAN
status](https://www.r-pkg.org/badges/version/stacks)](https://CRAN.R-project.org/package=stacks)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-blue.svg)](https://www.tidyverse.org/lifecycle/#experimental)
<!-- badges: end -->

## stacks - tidy model stacking <a href='https://stacks.tidymodels.org'><img src='man/figures/logo.png' align="right" height="280" /></a>
Expand All @@ -25,7 +24,7 @@ The process goes something like this:
[parsnip](https://parsnip.tidymodels.org/),
[workflows](https://workflows.tidymodels.org/),
[recipes](https://recipes.tidymodels.org/), and
[tune](http://tune.tidymodels.org/)
[tune](https://tune.tidymodels.org/)
2. Initialize a `data_stack` object with `stacks()`
3. Iteratively add candidate ensemble members to the `data_stack` with
`add_candidates()`
Expand Down Expand Up @@ -112,19 +111,18 @@ vignette for an example of how this grammar is implemented\!

## contributing

This project is released with a [Contributor Code of
Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree
This project is released with a [Contributor Code of Conduct](https://github.com/tidymodels/stacks/blob/main/CODE_OF_CONDUCT.md). 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://rstd.io/tidymodels-community).
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/stacks/issues).

- Either way, learn how to create and share a
[reprex](https://rstd.io/reprex) (a minimal, reproducible example),
[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
Expand Down
28 changes: 28 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# stacks 0.1.0

This submission is a resubmission following a request to adjust a URL with
200 status.

## Test environments

* local macOS install, R 3.6.3
* macOS (on github actions), release
* ubuntu 16.04 (on github actions), release, devel
* windows (on github actions), R 3.6.3, release
* windows (on win-builder), devel

## R CMD check results

There were 0 ERRORs, 0 WARNINGs, and 0 NOTEs on all systems except
the following NOTE on win-builder:

```
* checking CRAN incoming feasibility ... NOTE
Maintainer: 'Simon Couch <[email protected]>'
New submission
```

## Reverse dependencies

This package currently has no reverse dependencies.
6 changes: 3 additions & 3 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions tests/testthat/test_utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ context("helpers")
if ((!on_cran()) || interactive()) {load(test_path("helper_data.Rda"))}

test_that("object types relate as expected", {
skip_on_cran()

atts_d <- attributes(st_reg_1)

expect_true(check_inherits(st_reg_1, "data_stack"))
Expand All @@ -19,6 +21,8 @@ test_that("object types relate as expected", {
})

test_that("control_* functions work", {
skip_on_cran()

ctrl_grid <- control_stack_grid()
ctrl_bayes <- control_stack_bayes()
ctrl_res <- control_stack_resamples()
Expand All @@ -37,6 +41,8 @@ test_that("control_* functions work", {
})

test_that("misc. utilities work", {
skip_on_cran()

expect_error(check_inherits("howdy", "numeric"), "`howdy` needs to inherit")
expect_true(check_inherits("howdy", "character"))

Expand Down

0 comments on commit 95b4c4e

Please sign in to comment.