Skip to content

Commit

Permalink
Spring cleaning 🧼 (#252)
Browse files Browse the repository at this point in the history
* Rename .r -> .R

* Update GH actions

* Update CoC

* Update license, DESCRIPTION

* Add badges, pak to README

* Update GH actions
  • Loading branch information
juliasilge authored Mar 6, 2023
1 parent 82065a1 commit e76e703
Show file tree
Hide file tree
Showing 12 changed files with 52 additions and 27 deletions.
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ representative at an online or offline event.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at codeofconduct@rstudio.com.
reported to the community leaders responsible for enforcement at codeofconduct@posit.co.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/R-CMD-check-hard.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- uses: r-lib/actions/setup-pandoc@v2

Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,28 +22,29 @@ jobs:
fail-fast: false
matrix:
config:
- {os: macOS-latest, r: 'release'}
- {os: macos-latest, r: 'release'}

- {os: windows-latest, r: 'release'}
# Don't use Windows 3.6 build to avoid igraph always being
# installed from source and failing
# Use 3.6 to trigger usage of RTools35
# - {os: windows-latest, r: '3.6'}
# use 4.1 to check with rtools40's older compiler
- {os: windows-latest, r: '4.1'}

- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
- {os: ubuntu-latest, r: 'release'}
- {os: ubuntu-latest, r: 'oldrel-1'}
- {os: ubuntu-latest, r: 'oldrel-2'}
- {os: ubuntu-latest, r: 'oldrel-3'}
# Don't use R 3.4 build. survival, mda, TH.data require >=3.5.
# Don't use R 3.5: RSpectra, timeDate, glmnet require >=3.6
# - {os: ubuntu-latest, r: 'oldrel-4'}

env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- uses: r-lib/actions/setup-pandoc@v2

Expand All @@ -55,7 +56,6 @@ jobs:

- uses: r-lib/actions/setup-r-dependencies@v2
with:
pak-version: devel
extra-packages:
any::rcmdcheck,
randomForest=?ignore-before-r=4.1.0,
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- uses: r-lib/actions/setup-pandoc@v2

Expand All @@ -39,7 +39,7 @@ jobs:

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/[email protected].4
uses: JamesIves/github-pages-deploy-action@v4.4.1
with:
clean: false
branch: gh-pages
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pr-commands.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- uses: r-lib/actions/pr-fetch@v2
with:
Expand Down Expand Up @@ -51,7 +51,7 @@ jobs:
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- uses: r-lib/actions/pr-fetch@v2
with:
Expand Down
23 changes: 21 additions & 2 deletions .github/workflows/test-coverage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- uses: r-lib/actions/setup-r@v2
with:
Expand All @@ -27,5 +27,24 @@ jobs:
needs: coverage

- name: Test coverage
run: covr::codecov(quiet = FALSE)
run: |
covr::codecov(
quiet = FALSE,
clean = FALSE,
install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
)
shell: Rscript {0}

- name: Show testthat output
if: always()
run: |
## --------------------------------------------------------------------
find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true
shell: bash

- name: Upload test results
if: failure()
uses: actions/upload-artifact@v3
with:
name: coverage-test-failures
path: ${{ runner.temp }}/package
12 changes: 6 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Version: 0.3.1.9000
Authors@R: c(
person("Joyce", "Cahoon", , "[email protected]", role = "aut",
comment = c(ORCID = "0000-0001-7217-4702")),
person("Davis", "Vaughan", , "davis@rstudio.com", role = "aut"),
person("Max", "Kuhn", , "max@rstudio.com", role = "aut"),
person("Davis", "Vaughan", , "davis@posit.co", role = "aut"),
person("Max", "Kuhn", , "max@posit.co", role = "aut"),
person("Alex", "Hayes", , "[email protected]", role = "aut"),
person("Julia", "Silge", , "julia.silge@rstudio.com", role = c("cre", "aut"),
person("Julia", "Silge", , "julia.silge@posit.co", role = c("cre", "aut"),
comment = c(ORCID = "0000-0002-3671-836X")),
person("RStudio", role = c("cph", "fnd"))
person(given = "Posit, PBC", role = c("cph", "fnd"))
)
Description: Provides a set of S3 generics to axe components of fitted
model objects and help reduce the size of model objects saved to disk.
Expand All @@ -18,7 +18,7 @@ URL: https://butcher.tidymodels.org/,
https://github.com/tidymodels/butcher
BugReports: https://github.com/tidymodels/butcher/issues
Depends:
R (>= 3.4.0)
R (>= 3.5.0)
Imports:
cli (>= 3.3.0),
lobstr (>= 1.1.2),
Expand All @@ -45,8 +45,8 @@ Suggests:
fs,
ipred,
kernlab,
klaR,
kknn,
klaR,
knitr,
MASS,
mda,
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
YEAR: 2019
COPYRIGHT HOLDER: Joyce Cahoon
COPYRIGHT HOLDER: butcher authors
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MIT License

Copyright (c) 2019 Joyce Cahoon
Copyright (c) 2019 butcher authors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
File renamed without changes.
8 changes: 5 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ knitr::opts_chunk$set(
# butcher <a href='https://butcher.tidymodels.org/'><img src='man/figures/logo.png' align="right" height="139" /></a>

<!-- badges: start -->
[![Codecov test coverage](https://codecov.io/gh/tidymodels/butcher/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/butcher?branch=main)
[![R-CMD-check](https://github.com/tidymodels/butcher/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/butcher/actions/workflows/R-CMD-check.yaml)
[![CRAN status](https://www.r-pkg.org/badges/version/butcher)](https://CRAN.R-project.org/package=butcher)
[![Codecov test coverage](https://codecov.io/gh/tidymodels/butcher/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/butcher?branch=main)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->

## Overview
Expand All @@ -40,8 +42,8 @@ install.packages("butcher")
Or install the development version from [GitHub](https://github.com/):

```{r, eval = FALSE}
# install.packages("devtools")
devtools::install_github("tidymodels/butcher")
# install.packages("pak")
pak::pkg_install("tidymodels/butcher")
```

## Butchering
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@

<!-- badges: start -->

[![R-CMD-check](https://github.com/tidymodels/butcher/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/butcher/actions/workflows/R-CMD-check.yaml)
[![CRAN
status](https://www.r-pkg.org/badges/version/butcher)](https://CRAN.R-project.org/package=butcher)
[![Codecov test
coverage](https://codecov.io/gh/tidymodels/butcher/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/butcher?branch=main)
[![R-CMD-check](https://github.com/tidymodels/butcher/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/butcher/actions/workflows/R-CMD-check.yaml)
[![Lifecycle:
stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->

## Overview
Expand Down Expand Up @@ -36,8 +40,8 @@ install.packages("butcher")
Or install the development version from [GitHub](https://github.com/):

``` r
# install.packages("devtools")
devtools::install_github("tidymodels/butcher")
# install.packages("pak")
pak::pkg_install("tidymodels/butcher")
```

## Butchering
Expand Down

0 comments on commit e76e703

Please sign in to comment.