Skip to content

Install a built tarball, so the vignette is actually installed - #30

Merged
chross22 merged 1 commit into
masterfrom
install-vignettes
Aug 7, 2026
Merged

Install a built tarball, so the vignette is actually installed#30
chross22 merged 1 commit into
masterfrom
install-vignettes

Conversation

@chross22

@chross22 chross22 commented Aug 7, 2026

Copy link
Copy Markdown
Owner

vignette("datamatch") came back empty after every rebuild, in both R installs.

install_all.sh ran R CMD INSTALL on the source directory, and installing a directory copies the .Rmd without building the vignette index — so nothing is registered.

--build-vignettes is not the fix

It belongs to R CMD build. R CMD INSTALL answers:

Warning: unknown option '--build-vignettes'
** installing vignettes

and carries on succeeding. I tried it first and it appeared to work — the script reported success and the vignette was still missing. Worth finding out rather than assuming.

What the script does now

Builds a tarball once, installs that into each R. Slower by the length of a build, and the only way the index reaches the library.

Vignettes need pandoc, which on a Mac is often only present as the copy RStudio bundles, so that is added to PATH when nothing else provides one. Without pandoc the build retries with --no-build-vignettes rather than failing — an installed package without a vignette beats no installed package — and says which happened.

Verified

R 4.6.1 -> datamatch
R 4.3.2 -> datamatch

R CMD checkStatus: OK, 778 tests, vignette rebuilding cleanly.

🤖 Generated with Claude Code

vignette("datamatch") came back empty after every rebuild. The script
ran `R CMD INSTALL` on the source directory, and installing a directory
copies the .Rmd without building the vignette index, so nothing is
registered.

`--build-vignettes` is not the fix: it belongs to R CMD build, and
R CMD INSTALL answers "unknown option" and carries on succeeding. That
was worth finding out rather than assuming, since the run reported
success either way.

So the script now builds a tarball once and installs that into each R.
Slower by the length of a build, and the only way the index reaches the
library.

Vignettes need pandoc, which is often only present on a Mac as the copy
RStudio bundles, so that is added to PATH when nothing else provides
one. Without pandoc the build retries with --no-build-vignettes rather
than failing: an installed package without a vignette beats no installed
package, and it says which happened.

Verified: vignette("datamatch") now resolves in both R 4.6.1 and 4.3.2.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@chross22
chross22 merged commit 7feb0f6 into master Aug 7, 2026
5 checks passed
@chross22
chross22 deleted the install-vignettes branch August 7, 2026 21:04
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