Skip to content

Commit

Permalink
Undo some of the changes introduced by merging with master.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexzwanenburg committed Sep 21, 2024
1 parent 135771d commit d038048
Show file tree
Hide file tree
Showing 10 changed files with 240 additions and 65 deletions.
26 changes: 14 additions & 12 deletions .github/ISSUE_TEMPLATE/cran-release-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,33 @@ assignees: ''
- [ ] increment package version
- [ ] create release name
- [ ] update NEWS.md
- [ ] code check: run devtools::check(args=c("--no-examples", "--no-tests"), vignettes=FALSE), alternatively rcmdcheck::rcmdcheck(args=c("--no-examples", "--no-tests"))
- [ ] test check: run devtools::test(): set options("testthat.progress.max_fails"=Inf) and options("Ncpus"=10)
- [ ] create archives for testing backward compatibility against future versions: run tests/old_experiments/archiveExperiments.R
- [ ] test backward compatibility against archived experiments: manually run tests/testthat/test-update_object.R
- [ ] pre-compile vignettes: run vignettes/compile.R
- [ ] code and vignette check: run devtools::check(args=c("--no-examples", "--no-tests")), alternatively rcmdcheck::rcmdcheck(args=c("--no-examples", "--no-tests"))
- [ ] reverse dependencies: run revdepcheck::revdep_check()
- [ ] reverse dependencies: mail maintainers using revdepcheck::revdep_email()
- [ ] run check: rhub::check_for_cran()
- [ ] code check: run `devtools::check(args=c("--no-examples", "--no-tests"), vignettes=FALSE)`, alternatively `rcmdcheck::rcmdcheck(args=c("--no-examples", "--no-tests"))`
- [ ] test check: run `devtools::test()`: set `options("testthat.progress.max_fails"=Inf)` and `options("Ncpus"=10)`
- [ ] create archives for testing backward compatibility against future versions: run `tests/old_experiments/archiveExperiments.R`
- [ ] test backward compatibility against archived experiments: manually run `tests/testthat/test-update_object.R`
- [ ] pre-compile vignettes: run `vignettes/compile.R`
- [ ] code and vignette check: `rcmdcheck::rcmdcheck(args=c("--no-examples", "--as-cran"))`
- [ ] check reverse dependencies
- [ ] create pull request
- [ ] check continuous integration tests
- [ ] Build source tarball using `devtools::build()`.
- [ ] Run `devtools::check_built(path=pkg, env_vars = list("_R_CHECK_DEPENDS_ONLY_" = TRUE))`, with pkg the path to the tarball.
- [ ] update cran_comments.md
- [ ] merge dev branch into master

**Post-merge**
- [ ] Check for merging errors.
- [ ] Run a post-merge code check: devtools::check(env_vars = c("NOT_CRAN"="false"), args=c("--as-cran"))
- [ ] Run a post-merge code check: `rcmdcheck::rcmdcheck(args=c("--no-examples", "--as-cran"))`
- [ ] Run post-merge test suite, if required.
- [ ] Pre-compile vignettes, if required.
- [ ] Rebuild source tarball using `devtools::build()`, if required.

**CRAN**
- [ ] Build source tarball using devtools::build().
- [ ] Check CRAN-policies on https://cran.r-project.org/web/packages/policies.html
- [ ] Upload source tarball to https://cran.r-project.org/submit.html
- [ ] Check CRAN checks

**Github release**
- [ ] prepare a GithHub release
- [ ] create source tarball using devtools::build and add as binary.
- [ ] copy news from NEWS.md
- [ ] add source tarball as data
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Documentation
about: Template for suggesting documentation changes
title: ''
labels: documentation
assignees: ''

---

Please use the below template to submit your issue:

# Documentation changes

What new addition or change to the documentation would you like to see?
Where should this addition or change be made? If relevant, provide the name of the method, class or function.

# Specifications

- `familiar` version:
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/general-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bugs and problems
about: General issue template
title: ''
labels: bug
assignees: ''

---

Please use the below template to submit your issue:

# Expected behaviour

What did you expect `familiar` to do?

# Observed behaviour

What did `familiar` actually do? What error (if any) was produced?

# Steps to reproduce the problem

What steps are required to reproduce the problem? If possible, provide code and data that led to the problem.

# Specifications

- `familiar` version:
- `R` version:
- Operating system:
- Other package versions (*if relevant*):
8 changes: 5 additions & 3 deletions .github/ISSUE_TEMPLATE/internal-patch-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,20 @@ assignees: ''
---

**Prior to merge with master**
- [ ] code check: run devtools::check(args=c("--no-examples", "--no-tests"), vignettes=FALSE); alternatively rcmdcheck::rcmdcheck(args=c("--no-examples", "--no-tests"))
- [ ] test check: run devtools::test(): set options("testthat.progress.max_fails"=Inf) and options("Ncpus"=10)
- [ ] code check: run `devtools::check(args=c("--no-examples", "--no-tests"), vignettes=FALSE)`; alternatively `rcmdcheck::rcmdcheck(args=c("--no-examples", "--no-tests"))`
- [ ] test check: run `devtools::test()`: set options("testthat.progress.max_fails"=Inf) and options("Ncpus"=10)
- [ ] create archives for testing backward compatibility against future versions: run tests/old_experiments/archiveExperiments.R
- [ ] test backward compatibility against archived experiments: manually run tests/testthat/test-update_object.R
- [ ] increment minor package version
- [ ] create release name
- [ ] update NEWS.md
- [ ] create pull request
- [ ] check continuous integration tests
- [ ] merge patches into master

**Post-merge**
- [ ] Check for merging errors.
- [ ] Run a post-merge code check: devtools::check(args=c("--no-examples", "--no-tests"), vignettes=FALSE)
- [ ] Run a post-merge code check: `rcmdcheck::rcmdcheck(args=c("--no-examples", "--as-cran"))`
- [ ] Run post-merge test suite, if required.

**Github release**
Expand Down
56 changes: 56 additions & 0 deletions .github/workflows/auto-test-no-suggests-pull.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
#
# See https://github.com/r-lib/actions/tree/master/examples#readme for
# additional example workflows available for the R community.

name: Run R CMD check for strong dependencies only (nosuggests)

on: [pull_request, workflow_dispatch]

permissions:
contents: read

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
r-version: ["release"]
os: [ windows-latest ]

steps:
- uses: actions/checkout@v4
- uses: r-lib/actions/setup-pandoc@v2
- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
dependencies: '"hard"'
cache: false
extra-packages: |
any::rcmdcheck
any::testthat
needs: check

- name: Identify and remove all non-critical packages
run: |
installed_packages <- data.table::data.table(utils::installed.packages())
required_packages <- c("familiar", "rcmdcheck", "testthat")
required_packages <- union(required_packages, unlist(tools::package_dependencies(required_packages, recursive = TRUE), use.names=FALSE))
required_packages <- union(required_packages, installed_packages[Priority == "base"]$Package)
non_critical_packages <- setdiff(installed_packages$Package, required_packages)
for (package in non_critical_packages) {utils::remove.packages(installed_packages[Package == package]$Package, installed_packages[Package == package]$LibPath)}
shell: Rscript {0}

- uses: r-lib/actions/check-r-package@v2
with:
upload-snapshots: true
args: 'c("--no-manual", "--as-cran", "--no-vignettes", "--no-build-vignettes")'
build_args: 'c("--no-build-vignettes", "--no-manual")'
error-on: '"error"'
43 changes: 43 additions & 0 deletions .github/workflows/auto-test-package_pull.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
#
# See https://github.com/r-lib/actions/tree/master/examples#readme for
# additional example workflows available for the R community.

name: Run R CMD for different OS

on: [pull_request, workflow_dispatch]

permissions:
contents: read

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
r-version: ["release"]
os: [ ubuntu-latest, macos-latest, windows-latest ]

steps:
- uses: actions/checkout@v4
- uses: r-lib/actions/setup-pandoc@v2
- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: |
any::rcmdcheck
needs: check

- uses: r-lib/actions/check-r-package@v2
with:
upload-snapshots: true
args: 'c("--no-manual", "--as-cran", "--no-vignettes", "--no-build-vignettes")'
build_args: 'c("--no-build-vignettes", "--no-manual")'
error-on: '"error"'
46 changes: 46 additions & 0 deletions .github/workflows/auto-test-package_time_trigger.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
#
# See https://github.com/r-lib/actions/tree/master/examples#readme for
# additional example workflows available for the R community.

name: build-check

on:
workflow_dispatch:
schedule:
- cron: '30 6 1,15 * *'

permissions:
contents: read

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
r-version: ["release"]
os: [ ubuntu-latest, macos-latest, windows-latest ]

steps:
- uses: actions/checkout@v4
- uses: r-lib/actions/setup-pandoc@v2
- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: |
any::rcmdcheck
needs: check

- uses: r-lib/actions/check-r-package@v2
with:
upload-snapshots: true
args: 'c("--no-manual", "--as-cran", "--no-vignettes", "--no-build-vignettes")'
build_args: 'c("--no-build-vignettes", "--no-manual")'
error-on: '"error"'
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@
doc
Meta
tests/testthat/Rplots.pdf
inst/doc
/doc/
/Meta/
/man/
*.Rd
tests/old_experiments/_experiment
Rplots.pdf
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# Familiar <img src="icon/familiar.svg" align="right" width="120"/>
<img src="icon/familiar.svg" align="right" width="120"/>

![GitHub License](https://img.shields.io/github/license/alexzwanenburg/familiar)
![CRAN Version](https://img.shields.io/cran/v/familiar)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/alexzwanenburg/familiar/auto-test-package_time_trigger.yml)

# Familiar

## Overview

Expand Down
67 changes: 21 additions & 46 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Update familiar to version 1.4.6
Update familiar to version 1.4.8

Vignettes are pre-compiled to avoid long compilation times on build (several minutes).

Expand All @@ -8,65 +8,40 @@ Longer tests and tests involving parallel processing are not performed on CRAN,

## R CMD check results

R CMD check was run on R-hub using rhub::check_for_cran(), producing the following results:
R CMD check was run on GitHub using https://github.com/alexzwanenburg/familiar/actions/workflows/auto-test-package_pull.yml

----------------------------------
Windows Server 2022, R-devel, 64 bit:
0 errors | 0 warnings | 4 notes

* checking installed package size ... NOTE
installed size is 5.8Mb
sub-directories of 1Mb or more:
R 3.5Mb
doc 1.0Mb
help 1.2Mb

**Maintainer**: The size of the R-directory is due to source code. Addressing the size of the R directory would require creating a set of mutually dependent packages. This would likely result in a larger footprint across the packages.

* checking HTML version of manual ... [39s] NOTE
Skipping checking math rendering: package 'V8' unavailable

**Maintainer**: I am not sure what the cause is, but it might be because the V8 package was not available on rhub.

* checking for non-standard things in the check directory ... NOTE
Found the following files/directories:
''NULL''

**Maintainer**: I am not sure what the cause is. However, NULL is not present as a directory or file.

* checking for detritus in the temp directory ... NOTE
Found the following files/directories:
'lastMiKTeXException'

**Maintainer**: This note only appeared on the Windows server test. It didn't appear locally (Windows 10) or the other builds.


window-latest:
0 errors | 0 warnings | 0 notes

----------------------------------
Fedora Linux, R-devel, clang, gfortran:
0 errors | 0 warnings | 1 notes
macos-latest
0 errors | 0 warnings | 1 note

* checking installed package size ... NOTE
installed size is 5.8Mb
installed size is 5.4Mb
sub-directories of 1Mb or more:
R 3.5Mb
doc 1.0Mb
help 1.2Mb
R 4.1Mb

----------------------------------
ubuntu-latest:
0 errors | 0 warnings | 0 notes

## R CMD check for strong dependencies only

R CMD check was run on GitHub using https://github.com/alexzwanenburg/familiar/actions/workflows/auto-test-no-suggests-pull.yml

----------------------------------
Ubuntu Linux 20.04.1 LTS, R-release, GCC:
ubuntu-latest:
0 errors | 0 warnings | 1 note

* checking installed package size ... NOTE
installed size is 5.9Mb
sub-directories of 1Mb or more:
doc 1.0Mb
help 1.1Mb
R 3.6Mb


* checking package dependencies ... NOTE
Packages suggested but not available for checking:
'BART', 'CORElearn', 'coro', 'dynamicTreeCut', 'e1071', 'Ecdat',
'fastcluster', 'fastglm', 'glmnet', 'harmonicmeanp', 'isotree',
'laGP', 'maxstat', 'mboost', 'microbenchmark', 'partykit', 'praznik',
'proxy', 'qvalue', 'randomForestSRC', 'ranger', 'VGAM', 'xgboost'

## Downstream dependencies

Expand Down

0 comments on commit d038048

Please sign in to comment.