Skip to content

Clean up make check: R6 method docs and R CMD check NOTEs - #13

Open
wolski wants to merge 2 commits into
mainfrom
check-notes
Open

wolski wants to merge 2 commits into
mainfrom
check-notes

Conversation

@wolski

@wolski wolski commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Cleans up what make check reports, apart from one NOTE that needs a decision (below).

Result

main (564572b) this branch
roxygen warnings in make document 92 0
R CMD check 0 errors, 0 warnings, 4 NOTEs 0 errors, 0 warnings, 1 NOTE

Changes

R6 method docs (commit 2):

  • @description / @param for every public method of ExploreDataset, ExploreDatasetSE, ExploreDatasetH5AD, ExploreDatasetParquet
  • Comments only; man/ regenerated with roxygen2 8.1.1

NOTE "R code for possible problems" (commit 1):

  • Calls in R/ qualified with pkg:: (stats::setNames, ggplot2::aes, grid::gpar, dendextend::colored_bars, …), the style R/ already uses elsewhere
  • Column names in aes() and dplyr verbs via .data$
  • importFrom for %>%, R6Class, .data
  • utils::globalVariables() for eds, input, seqAnnoReactive: the session objects the bind_to_scope() helpers read (Keep one copy of the 6 session-bound helpers, in R/ (part of #10) #12)

NOTEs "top-level files" and "CITATION file in a non-standard place":

  • CITATION.cff and SKILLS.md added to .Rbuildignore

DESCRIPTION:

  • devtools from Imports to Suggests: nothing in the package or app uses it
  • dendextend and rlang from Suggests to Imports: the package code now calls them

Prod: no base-image change; dendextend and rlang are already attached by app.R.

Not fixed: "Namespaces in Imports field not imported from"

24 packages (DT, plotly, shinydashboard, tidyverse, …) are used only by inst/app/, which R CMD check does not scan; rhdf5 is needed by anndataR to read .h5ad. They have to stay in Imports. Options: keep the NOTE, or reference them once from an internal function so check sees them.

Verification

  • make check (macOS, R 4.6.2): 0 errors, 0 warnings; tests pass
  • air format . --check: clean
  • App in dev mode (sources R/, as on prod), demo dataset: Summary, Ordination (samples plot, biplot), Heatmaps, Boxplots, Replicability (heatmap, dendrogram, dendrogram PDF download); no errors in the R log
  • Unrelated, already on main: 3 tests in test-prolfquapp_h5ad.R fail under devtools::test() but pass in R CMD check

Prepared with the assistance of an AI coding agent.

- Qualify base and package calls in R/ with pkg:: (stats, utils,
  grDevices, graphics, shiny, ggplot2, grid, ComplexHeatmap, ...)
- Column names in aes()/dplyr verbs via the .data pronoun
- importFrom for %>%, R6Class and .data; globalVariables for the
  session objects the bind_to_scope() helpers read
- devtools from Imports to Suggests; dendextend and rlang to Imports
- .Rbuildignore CITATION.cff and SKILLS.md

Assisted-by: AI coding agent
@description and @PARAM for every public method of ExploreDataset,
ExploreDatasetSE, ExploreDatasetH5AD and ExploreDatasetParquet, so
devtools::document() runs without roxygen warnings. man/ regenerated
with roxygen2 8.1.1.

Assisted-by: AI coding agent
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant