Merge pull request #350 from tidymodels/glance

glance method for model fits

Author: topepo

.github/workflows/R-CMD-check.yaml

@@ -15,10 +15,10 @@ jobs:
       fail-fast: false
       matrix:
         config:
-          - {os: macOS-latest,   r: 'devel'}
           - {os: macOS-latest,   r: 'release'}
           - {os: windows-latest, r: 'release'}
           - {os: windows-latest, r: '3.6'}
+          - {os: ubuntu-16.04,   r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
           - {os: ubuntu-16.04,   r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
           - {os: ubuntu-16.04,   r: 'oldrel',  rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
           - {os: ubuntu-16.04,   r: '3.5',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
@@ -54,12 +54,11 @@ jobs:
 
       - name: Install system dependencies
         if: runner.os == 'Linux'
-        env:
-          RHUB_PLATFORM: linux-x86_64-ubuntu-gcc
         run: |
-          Rscript -e "remotes::install_github('r-hub/sysreqs')"
-          sysreqs=$(Rscript -e "cat(sysreqs::sysreq_commands('DESCRIPTION'))")
-          sudo -s eval "$sysreqs"
+          while read -r cmd
+          do
+            eval sudo $cmd
+          done < <(Rscript -e 'cat(remotes::system_requirements("ubuntu", "16.04"), sep = "\n")')
 
       - name: Install dependencies
         run: |
@@ -102,7 +101,7 @@ jobs:
 
       - name: Upload check results
         if: failure()
-        uses: actions/upload-artifact@master
+        uses: actions/upload-artifact@main
         with:
           name: ${{ runner.os }}-r${{ matrix.config.r }}-results
           path: check

.github/workflows/pkgdown.yaml

@@ -32,18 +32,15 @@ jobs:
 
       - name: Install dependencies
         run: |
-          install.packages("remotes")
           remotes::install_deps(dependencies = TRUE)
-          remotes::install_dev("pkgdown")
-          remotes::install_github("tidyverse/tidytemplate")
-          remotes::install_cran("tidymodels")
-          remotes::install_cran("C50")
-          remotes::install_cran("modeldata")
+          install.packages("pkgdown")
         shell: Rscript {0}
 
       - name: Install package
         run: R CMD INSTALL .
 
       - name: Deploy package
-        run: pkgdown::deploy_to_branch(new_process = FALSE)
-        shell: Rscript {0}
+        run: |
+          git config --local user.email "actions@github.com"
+          git config --local user.name "GitHub Actions"
+          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'

.github/workflows/pr-commands.yaml

@@ -21,6 +21,8 @@ jobs:
         run: Rscript -e 'roxygen2::roxygenise()'
       - name: commit
         run: |
+          git config --local user.email "actions@github.com"
+          git config --local user.name "GitHub Actions"
           git add man/\* NAMESPACE
           git commit -m 'Document'
       - uses: r-lib/actions/pr-push@master
@@ -44,6 +46,8 @@ jobs:
         run: Rscript -e 'styler::style_pkg()'
       - name: commit
         run: |
+          git config --local user.email "actions@github.com"
+          git config --local user.name "GitHub Actions"
           git add \*.R
           git commit -m 'Style'
       - uses: r-lib/actions/pr-push@master

DESCRIPTION

@@ -31,7 +31,7 @@ Imports:
     prettyunits,
     vctrs (>= 0.2.0)
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.0.9000
+RoxygenNote: 7.1.1
 Suggests: 
     testthat,
     knitr,

NAMESPACE

@@ -2,6 +2,7 @@
 
 S3method(fit,model_spec)
 S3method(fit_xy,model_spec)
+S3method(glance,model_fit)
 S3method(has_multi_predict,default)
 S3method(has_multi_predict,model_fit)
 S3method(has_multi_predict,workflow)
@@ -121,6 +122,7 @@ export(get_fit)
 export(get_from_env)
 export(get_model_env)
 export(get_pred_type)
+export(glance)
 export(has_multi_predict)
 export(is_varying)
 export(keras_mlp)
@@ -198,6 +200,7 @@ importFrom(dplyr,tally)
 importFrom(dplyr,vars)
 importFrom(generics,fit)
 importFrom(generics,fit_xy)
+importFrom(generics,glance)
 importFrom(generics,tidy)
 importFrom(generics,varying_args)
 importFrom(glue,glue_collapse)

NEWS.md

@@ -1,5 +1,7 @@
 # parsnip (development version)
 
+ * A `glance()` method for `model_fit` objects was added (#325)
+
  * Specific `tidy()` methods for `glmnet` models fit via `parsnip` were created so that the coefficients for the specific fitted `parsnip` model are returned.
 
 # parsnip 0.1.2

R/reexports.R

@@ -14,3 +14,8 @@ generics::fit_xy
 #' @importFrom generics tidy
 #' @export
 generics::tidy
+
+
+#' @importFrom generics glance
+#' @export
+generics::glance

R/tidy.R

@@ -7,3 +7,14 @@
 #' @return a tibble
 #' @export
 tidy.model_fit <- function(x, ...) generics::tidy(x$fit, ...)
+
+
+#' Construct a single row summary "glance" of a model, fit, or other object
+#'
+#' This method glances the model in a parsnip model object, if it exists.
+#'
+#' @inheritParams generics::glance
+#'
+#' @return a tibble
+#' @export
+glance.model_fit <- function(x, ...) generics::glance(x$fit, ...)

R/zzz.R

@@ -7,6 +7,7 @@
   s3_register("broom::tidy", "_lognet")
   s3_register("broom::tidy", "_multnet")
   s3_register("broom::tidy", "_fishnet")
+  s3_register("broom::glance", "model_fit")
 }
 
 

README.Rmd

@@ -21,6 +21,7 @@ knitr::opts_chunk$set(
 [![CRAN status](https://www.r-pkg.org/badges/version/parsnip)](https://CRAN.R-project.org/package=parsnip)
 [![Downloads](http://cranlogs.r-pkg.org/badges/parsnip)](https://cran.rstudio.com/package=parsnip)
 [![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
+[![R build status](https://github.com/tidymodels/parsnip/workflows/R-CMD-check/badge.svg)](https://github.com/tidymodels/parsnip/actions)
 <!-- badges: end -->
 
 ## Introduction
@@ -112,6 +113,7 @@ rand_forest(mtry = 10, trees = 2000) %>%
 Either one of these model specifications can be fit in the same way:
 
 ```{r}
+set.seed(192)
 rand_forest(mtry = 10, trees = 2000) %>%
   set_engine("ranger", importance = "impurity") %>%
   set_mode("regression") %>%