dm incompatible with pkgdown in a package that imports dm

[MatthewHeun]

Steps to reproduce:

• Use RStudio to start a new project of type package in an empty folder. I created the empty folder at ~/Desktop/testdmpkgdown/ like this:

• Add the line "Imports: dm" to the DESCRIPTION file
• Install the package (Build|Install Package)
• Type "pkgdown:::build_site_external()" in the console (Or choose "Build pkgdown" from the Addins menu)

Expected result:

• Browser window opens with a (very rudimentary) pkgdown site for the new package

Actual result:

Error: 
! in callr subprocess.
Caused by error in `load_imports(path)`:
! 
ℹ See `$stdout` for standard output.
Type .Last.error to see the more details.

Here is the output from .Last.error:

<callr_error/rlib_error_3_0/rlib_error/error>
Error: 
! in callr subprocess.
Caused by error in `load_imports(path)`:
! 
ℹ See `$stdout` for standard output.
---
Backtrace:
1. pkgdown:::build_site_external()
2. callr::r(function(..., cli_colors, pkgdown_internet) { …
3. callr:::get_result(output = out, options)
4. callr:::throw(callr_remote_error(remerr, output), parent = fix_msg(remerr[[3]]))
---
Subprocess backtrace:
 1. pkgdown::build_site(...)
 2. pkgdown:::build_site_local(pkg = pkg, examples = examples, run_dont_run = run_dont_run, …
 3. pkgdown::build_reference(pkg, lazy = lazy, examples = examples, run_dont_run = run_dont_…
 4. pkgdown:::examples_env(pkg, seed = seed, devel = devel)
 5. pkgload::load_all(pkg$src_path, export_all = FALSE, helpers = FALSE, …
 6. pkgload:::load_imports(path)
 7. pkgload:::deps_check_installed(path, imports)
 8. rlang::check_installed(pkg, action = action, call = call)
 9. base::stop(cnd)
10. global (function (e) …

Impact:

• This issue prevents constructing pkgdown documentation websites for packages that Imports: dm.

Workarounds:

• None known at this time.

Additional information:

• All other imported packages that I tried work correctly. For example,
  • "Imports: magrittr" works
  • "Imports: stringi" works
• Any time "dm" is included in the Imports: field, the error occurs.
  • "Imports: magrittr, dm" fails
  • "Imports: stringi, dm" fails

Machine, OS, etc:

• macOS Sonoma 14.1.1
• R 4.3.2
• RStudio 2023.12.1+402
• dm 1.0.10
• pkgdown 2.0.7

[krlmlr]

Thanks, this is weird.

@dickoa @josesamos: You have packages that import dm. Can you build pkgdown sites for these packages?

[krlmlr]

@maelle: Is there a way to track which pkgdown package is being built currently? If not, would it be feasible to provide one?

The reason I'm asking: we are doing fairly restrictive checks in pkgdown mode that are irrelevant when other packages are built with pkgdown.

[dickoa]

Sorry for the delay in getting back to you. I'm importing dm in robotoolbox and never had an issue with pkgdown (at least don't remember having one).

[krlmlr]

@MatthewHeun: Based on Copilot's analysis, the build might work if DiagrammeR and DiagrammeRsvg are installed. Let's investigate further.

[maelle]

@krlmlr

Is there a way to track which pkgdown package is being built currently? If not, would it be feasible to provide one?

Can you please clarify your question? You don't mean https://pkgdown.r-lib.org/pkgdown.yml?

[krlmlr]

dm is querying the IN_PKGDOWN variable in its .onLoad() and checks various things. This is breaking other packages.

I see:

https://github.com/r-lib/pkgdown/blob/f3ec6e2bb122e10436eccda7b221e297ab9d395a/R/pkgdown.R#L13-L19

This probably means that there is currently no way to tell which particular package is being built by pkgdown. I wonder if we could set IN_PKGDOWN to the name of the package (instead of "true") or additionally set a new env var IN_PKGDOWN_PKG .

[maelle]

Aaaah I see what you mean now. r-lib/pkgdown#2977