NIDAP-Community / DSPWorkflow

https://nidap-community.github.io/DSPWorkflow/
MIT License
5 stars 3 forks source link

Use continuous integration to run `R CMD check` #128

Open kelly-sovacool opened 1 year ago

kelly-sovacool commented 1 year ago

Currently, devtools::check() fails locally for me due to #126 & #127 with:

── R CMD check results ──────────────────────────────────────────────────────────────────── DSPWorkflow 1.2.0.0 ────
Duration: 14.2s

❯ checking package dependencies ... ERROR
  Packages required and available but unsuitable versions:
    'dplyr', 'GeomxTools', 'ggforce', 'ggplot2', 'grid', 'gtable',
    'knitr', 'NanoStringNCTools', 'patchwork', 'stats', 'SpatialDecon',
    'tibble', 'tidyr', 'umap', 'ComplexHeatmap'

  Depends: includes the non-default packages:
    'Biobase', 'BiocGenerics', 'cowplot', 'dplyr', 'GeomxTools',
    'ggforce', 'ggplot2', 'gridExtra', 'grid', 'gtable', 'knitr',
    'NanoStringNCTools', 'patchwork', 'reshape2', 'Rtsne', 'scales',
    'SpatialDecon', 'tibble', 'tidyr', 'umap', 'magrittr',
    'ComplexHeatmap'
  Adding so many packages to the search path is excessive and importing
  selectively is preferable.

  See section ‘The DESCRIPTION file’ in the ‘Writing R Extensions’
  manual.

1 error ✖ | 0 warnings ✔ | 0 notes ✔

I would recommend creating a GitHub Action that automatically runs check on pushes & pull requests on the default branch. Here's an example: https://github.com/r-lib/actions/blob/v2/examples/check-standard.yaml

This way you'll know the package is at least installable on any new pushes/PRs.