Use YAML for comment

ropensci · Oct 1, 2024 · 571aa72 · 571aa72
1 parent a2a38e0
commit 571aa72
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/vignettes/precompile.R b/vignettes/precompile.R
@@ -15,13 +15,14 @@ build_vignettes()
 
 # x = vignette file name including file extension (e.g., "rredlist.Rmd")
 read_only <- function(x) {
+  # Create file
   tmp <- file(x)
-  nlines <- grep("^---\\s*$", readLines(x))[2]
-  writeLines(
-    c(readLines(x)[1:(nlines + 1)],
-      paste0("<!-- Generated by vignettes/precompile.R: do not edit by hand.\n",
-             "Please edit source in vignettes/source/_", x, " -->"),
-      readLines(x)[(nlines + 2):length(readLines(x))]), tmp)
+  # write lines
+  writeLines(c(c("---"),
+               c("comment: >"),
+               c("  Generated by vignettes/precompile.R: do not edit by hand."),
+               paste0("  Please edit source in vignettes/source/_", x),
+               readLines(x)[2:length(readLines(x))]), tmp)
   close(tmp)
 }
 # Add read only info

diff --git a/vignettes/rredlist.Rmd b/vignettes/rredlist.Rmd
@@ -1,4 +1,7 @@
 ---
+comment: >
+  Generated by vignettes/precompile.R: do not edit by hand.
+  Please edit source in vignettes/source/_rredlist.Rmd
 title: "Introduction to rredlist"
 author: "William Gearty"
 date: "2024-10-01"
@@ -9,8 +12,6 @@ vignette: >
   %\VignetteEncoding{UTF-8}
 ---
 
-<!-- Generated by vignettes/precompile.R: do not edit by hand.
-Please edit source in vignettes/source/_rredlist.Rmd -->
 
 
 `rredlist` is an R client for the IUCN Red List API (https://api.iucnredlist.org/).