From 5a7015936f22365c6d5572322fade1390dd184c7 Mon Sep 17 00:00:00 2001 From: David <david.dorchies@inrae.fr> Date: Thu, 5 Dec 2024 02:38:06 +0100 Subject: [PATCH] fix(mermaid): error in mermaid example Moreover dontrun directive is better used to protect against network failure during check --- R/plot.GRiwrm.R | 6 ++++-- man/mermaid.Rd | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/R/plot.GRiwrm.R b/R/plot.GRiwrm.R index ae3155d..939829f 100644 --- a/R/plot.GRiwrm.R +++ b/R/plot.GRiwrm.R @@ -183,9 +183,9 @@ getNodeClass <- function(id, griwrm) { #' @export #' #' @examples -#' \dontrun{ #' diagram <- "flowchart LR\n A --> B" #' mermaid_gen_link(diagram) +#' \dontrun{ #' f <- mermaid(diagram) #' f #' @@ -308,10 +308,12 @@ plot_png <- function(path, add = FALSE) { #' @rdname mermaid #' #' @examples +#' \dontrun{ #' s <- "flowchart LR -#' A -> B" +#' A --> B" #' class(s) <- c("mermaid", class(s)) #' plot(s) +#' } plot.mermaid <- function(x, add = FALSE, ...) { file_mmd <- mermaid(x, ...) if (is.na(file_mmd)) { diff --git a/man/mermaid.Rd b/man/mermaid.Rd index c10eefe..433e6a6 100644 --- a/man/mermaid.Rd +++ b/man/mermaid.Rd @@ -69,9 +69,9 @@ If the generation failed (due to internet connection failure or syntax error in mermaid script), the functions raises no error (see \code{mermaid} returned value). } \examples{ -\dontrun{ diagram <- "flowchart LR\n A --> B" mermaid_gen_link(diagram) +\dontrun{ f <- mermaid(diagram) f @@ -82,8 +82,10 @@ knitr::include_graphics(mermaid(diagram)) unlink(f) } +\dontrun{ s <- "flowchart LR -A -> B" +A --> B" class(s) <- c("mermaid", class(s)) plot(s) } +} -- GitLab