Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Template gets "Package vignette without corresponding tangle output" with r-devel #242

Open
statnmap opened this issue Feb 2, 2024 · 2 comments
Labels

Comments

@statnmap
Copy link
Collaborator

statnmap commented Feb 2, 2024

This problem is reproducible using {rig} with R-devel version locally on Ubuntu, when running devtools::check() on {fusen}.
However, this is not reproducible directly and interactively on the package "full" when extracted from the output.

Maybe an artifact of devtools::check() ?
Let's see if there are other packages with this same error where there is an explanation...

  ── Failure ('test-inflate-part2.R:440:9'): inflate() output no error ───────────
  check_out[["notes"]] (`actual`) not equal to "zero notes" (`expected`).
  
  lines(actual) vs lines(expected)
  - "checking package vignettes ... NOTE"
  - "Package vignette without corresponding tangle output:"
  - "  ‘get-started.Rmd’"
  + "zero notes"
@statnmap
Copy link
Collaborator Author

statnmap commented Feb 2, 2024

Search on https://duckduckgo.com/?t=ffab&q=%22Package+vignette+without+corresponding+tangle+output%22&ia=web

https://cran.r-project.org › web › checks › check_results_shape.html
CRAN Package Check Results for Package shape
Check Details. Version: 1.4.6 Check: package vignettes Result: NOTE Package vignette without corresponding tangle output: 'shape.Rnw' Flavors: r-devel-linux-x86_64-debian-clang, r-devel-linux-x86_64-debian-gcc, r-devel-linux-x86_64-fedora-clang, r-devel-linux-x86_64-fedora-gcc, r-devel-windows-x86_64 Check: package vignettes Result: NOTE

https://cran.r-project.org › web › checks › check_results_adiv.html
CRAN Package Check Results for Package adiv
Check: package vignettes. Result: NOTE Package vignette without corresponding tangle output: 'adivGuide.Rnw' Flavor: r-devel-linux-x86_64-debian-gcc. Version: 2.2. Check: re-building of vignette outputs.

https://cran.r-project.org › web › checks › check_results_HiCseg.html
CRAN Package Check Results for Package HiCseg
Version: 1.1 Check: package vignettes Result: NOTE Package vignette without corresponding tangle output: 'HiCseg.Rnw' Flavor: r-devel-linux-x86_64-debian-gcc Version: 1.1 Check: compiled code Result: NOTE File 'HiCseg/libs/HiCseg.so': Found no calls to: 'R_registerRoutines', 'R_useDynamicSymbols' It is good practice to register ...

https://cran.r-project.org › web › checks › check_results_gglasso.html
CRAN Package Check Results for Package gglasso
OK. r-oldrel-windows-x86_64. 1.5. 15.00. 87.00. 102.00. OK. Check Details. Version: 1.5 Check: package vignettes Result: NOTE Package vignette without corresponding tangle output: 'Introduction_to_gglasso_package.Rmd' Flavors: r-devel-linux-x86_64-debian-clang, r-devel-linux-x86_64-debian-gcc, r-devel-linux-x86_64-fedora-clang, r-devel ...

https://cran-archive.r-project.org › web › checks › 2024 › 2024-01-28_check_results_rich.html
CRAN Package Check Results for Package rich
Il y a 5 joursOK. r-oldrel-windows-x86_64. 1.0.1. 10.00. 141.00. 151.00. OK. Check Details. Version: 1.0.1 Check: package vignettes Result: NOTE Package vignette without corresponding tangle output: 'rich_introduction.Rmd' Flavors: r-devel-linux-x86_64-debian-clang, r-devel-linux-x86_64-debian-gcc, r-devel-linux-x86_64-fedora-clang, r-devel-linux-x86_64 ...

https://cran.rstudio.com › web › checks › check_results_shape.html
CRAN Package Check Results for Package shape - RStudio
Check Details. Version: 1.4.6 Check: package vignettes Result: NOTE Package vignette without corresponding tangle output: 'shape.Rnw' Flavors: r-devel-linux-x86_64-debian-clang, r-devel-linux-x86_64-debian-gcc Check: package vignettes Result: NOTE Package vignette without corresponding tangle output: 'shape.Rnw' Flavors: r-devel-linux

statnmap added a commit that referenced this issue Feb 2, 2024
- No idea about why there is 'Package vignette without corresponding tangle output' note in check package inside check fusen. Probably an artifact of using devtools::check() inside devtools::check(). Let's see how it goes in the future.

issue #242
@statnmap
Copy link
Collaborator Author

statnmap commented Apr 30, 2024

I think this is because we do not build documentation fully before running the check.
Indeed, if I compare package 'neat' where this CRAN error was fixed, we can see that the only interesting change is in the 'doc/' directory: R file associated with the vignette is now in the package.
image

I guess that :

  • When running devtools::check() vignettes are fully built before the checks verify the vignette, and the "doc/" directory.

  • In the case of 'fusen' unit tests, tests that fail on vignettes with "Package vignette without corresponding tangle output" are those where vignette documentation was not built before the checks. Indeed, we do not run devtools::check(), but rcmdcheck::rcmdcheck(), which does not build documentation before.

So, in the case of 'fusen', we can:

  • ✅ either ignore to check the vignette with --ignore-vignettes:
 check_out <- rcmdcheck::rcmdcheck(dummypackage,
      quiet = TRUE,
      args = c("--no-manual", "--ignore-vignettes")
    )
  • ❌ or build the 'doc/' directory before the 'rcmdcheck' : did not work
  devtools::build_vignettes()
# or
    tools::buildVignettes(dir = ".", tangle = TRUE)
  • ❌ or run devtools::check() instead of 'rcdmcheck' : This is not possible to run a devtools::check() inside a devtools::check()
Error in `if (binary) {
    build_setup_binary(path, dest_path, args, needs_compilation)
} else {
    build_setup_source(path, dest_path, vignettes, manual, clean_doc, 
        args, needs_compilation)
}`: argument is not interpretable as logical
Backtrace:
    ▆
 1. └─devtools::check(path = ".", quiet = TRUE) at test-inflate-part1.R:203:5
 2.   ├─withr::with_envvar(...)
 3.   │ └─base::force(code)
 4.   └─pkgbuild::build(...)
 5.     └─pkgbuild:::build_setup(...)

statnmap added a commit that referenced this issue Apr 30, 2024
Accept that this note arise as we dont run devtools::check() inside the devtools check

issue #242
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant