Simplify vignette precompilation

ropensci · Feb 11, 2024 · a28c3b7 · a28c3b7
1 parent 7160ae5
commit a28c3b7
Show file tree

Hide file tree

Showing 14 changed files with 168 additions and 527 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -8,7 +8,6 @@ README.Rmd
 travis-tool.sh
 cran-comments.md
 Makefile
-vignettes/
 appveyor.yml
 ^cran-comments\.md$
 ^revdep$
@@ -22,3 +21,6 @@ revdep/library.noindex
 ^\.github$
 ^README\.Rmd$
 ^codecov\.yml$
+^doc$
+^Meta$
+^vignettes/figure$
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,6 @@
 revdep/checks.noindex
 revdep/data.sqlite
 revdep/library.noindex
+inst/doc
+/doc/
+/Meta/
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -28,9 +28,13 @@ Imports:
     ggplot2,
     maps
 Suggests:
+    knitr,
+    rmarkdown,
     testthat,
-    vcr
+    vcr,
+    withr
 RoxygenNote: 7.3.1
 X-schema.org-applicationCategory: Data Access
 X-schema.org-keywords: species, occurrences, biodiversity, maps, vertnet, mammals, mammalia, specimens
 X-schema.org-isPartOf: "https://ropensci.org"
+VignetteBuilder: knitr
diff --git a/Makefile b/Makefile
@@ -1,16 +1,8 @@
 PACKAGE := $(shell grep '^Package:' DESCRIPTION | sed -E 's/^Package:[[:space:]]+//')
 RSCRIPT = Rscript --no-init-file
 
-all: move rmd2md
-
-move:
-	cd inst/vign;\
-	cp rvertnet.md ../../vignettes;\
-	cp -rf figure/* ../../vignettes/figure/
-
-rmd2md:
-	cd vignettes;\
-	mv rvertnet.md rvertnet.Rmd
+vignette:
+	${RSCRIPT} vignettes/precompile.R
 
 test:
 	${RSCRIPT} -e 'library(methods); devtools::test()'

diff --git a/inst/vign/figure/unnamed-chunk-11-1.png b/inst/vign/figure/unnamed-chunk-11-1.png
diff --git a/inst/vign/figure/unnamed-chunk-13-1.png b/inst/vign/figure/unnamed-chunk-13-1.png
diff --git a/inst/vign/rvertnet.md b/inst/vign/rvertnet.md
diff --git a/man/figures/unnamed-chunk-11-1.png b/man/figures/unnamed-chunk-11-1.png
diff --git a/man/figures/unnamed-chunk-13-1.png b/man/figures/unnamed-chunk-13-1.png
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -0,0 +1 @@
+*.html
diff --git a/vignettes/figure/vertmap-1.png b/vignettes/figure/vertmap-1.png
diff --git a/vignettes/precompile.R b/vignettes/precompile.R
@@ -0,0 +1,5 @@
+#Vignettes that depend on internet access have been precompiled:
+
+withr::with_dir('vignettes', knitr::knit("rvertnet.Rmd.orig", "rvertnet.Rmd"))
+
+devtools::build_vignettes()
diff --git a/vignettes/rvertnet.Rmd b/vignettes/rvertnet.Rmd
diff --git a/inst/vign/rvertnet.Rmd → vignettes/rvertnet.Rmd.orig b/inst/vign/rvertnet.Rmd → vignettes/rvertnet.Rmd.orig
@@ -1,8 +1,13 @@
-<!--
-%\VignetteEngine{knitr::knitr}
-%\VignetteIndexEntry{rvertnet introduction}
-%\VignetteEncoding{UTF-8}
--->
+---
+title: Introduction to rvertnet
+author: Scott Chamberlain
+date: "2020-01-28"
+output: rmarkdown::html_vignette
+vignette: >
+    %\VignetteIndexEntry{Introduction to rvertnet}
+    %\VignetteEngine{knitr::rmarkdown}
+    %\VignetteEncoding{UTF-8}
+---
 
 ```{r, eval=TRUE, echo=FALSE}
 knitr::opts_chunk$set(
@@ -13,9 +18,6 @@ knitr::opts_chunk$set(
 )
 ```
 
-rvertnet introduction
-=====================
-
 `rvertnet` is a client for interacting with [VertNet.org](http://vertnet.org/).
 
 ## Installation
@@ -98,7 +100,7 @@ res$data
 
 Pass output of `vertsearch()` to a map
 
-```{r fig.width=8, fig.height=4}
+```{r, vertmap, fig.width=8, fig.height=4, fig.cap = ""}
 out <- vertsearch(tax = "(mustela nivalis OR mustela erminea)")
 vertmap(out)
 ```