Merge branch 'dev'

# Conflicts: # DESCRIPTION # NEWS.md # codemeta.json
rkrug · Jun 22, 2020 · dacde08 · dacde08
2 parents 3ffd0a2 + 18fff2c
commit dacde08
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 5 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,8 +1,8 @@
 Package: plantuml
 Type: Package
 Title: Create UML Graphs using PlantUML Syntax
-Version: 0.3.2
-Date: 2020-06-19
+Version: 0.3.3
+Date: 2002-06-22
 Authors@R: 
     c(person(given = "Rainer M.",
              family = "Krug",

diff --git a/NEWS.md b/NEWS.md
@@ -1,7 +1,10 @@
+
+# v0.3.3
+- added `plantuml.preview` option to kitr engine which will show a preview in RStudio
+
 # 0.3.2
 - Adds `mode = "wd"` to the download of `plantuml.jar` to avoid corruption on windows
 
-
 # v0.3.1
 - added function to register knit engine `plantuml_knit_engine_register()`
 - fixed wrong behaviour when `echo = TRUE` and `eval = TRUE`

diff --git a/R/plantuml_knit_engine.R b/R/plantuml_knit_engine.R
@@ -10,6 +10,8 @@
 #'      - **eps**	To generate text in EPS format.
 #'  - **plantuml.path**: the path where the resulting files will be saved.
 #'    Default is the same directory as the `.Rmd` file is in. The path will be created if it does not exist.
+#'  - **plantuml.preview**: if `TRUE`, an inline preview will be shown in RStudio.
+#'    **Attention: the processing takse twice as long as without this option!**.
 #'
 #' Thanks to Emiliano Heyns (retorquere) for giving me the idea for this
 #' functiion https://github.com/rkrug/plantuml/issues/10#issue-639795529
@@ -94,7 +96,15 @@ plantuml_knit_engine <-  function(options) {
       options = options,
       out = out
     )
+    ###
+    if (isTRUE(options$plantuml.preview)) {
+      plot(
+        x = puml,
+        vector = TRUE
+      )
+    }
   }
+
   if (options$echo) {
     result$code <- knitr::engine_output(
       options = options,

diff --git a/codemeta.json b/codemeta.json
@@ -10,7 +10,7 @@
   "codeRepository": "https://github.com/rkrug/plantuml",
   "issueTracker": "https://github.com/rkrug/plantuml/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
@@ -145,7 +145,7 @@
   ],
   "releaseNotes": "https://github.com/rkrug/plantuml/blob/master/NEWS.md",
   "readme": "https://github.com/rkrug/plantuml/blob/master/README.md",
-  "fileSize": "296.292KB",
+  "fileSize": "316.547KB",
   "contIntegration": [
     "https://travis-ci.org/rkrug/plantuml",
     "https://codecov.io/github/rkrug/plantuml?branch=master"

diff --git a/man/plantuml_knit_engine.Rd b/man/plantuml_knit_engine.Rd
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+use_with_knitr.html
diff --git a/vignettes/use_with_knitr.R b/vignettes/use_with_knitr.R
@@ -0,0 +1,9 @@
+## ---- include = FALSE---------------------------------------------------------
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+
+## ----setup, include=TRUE------------------------------------------------------
+plantuml::plantuml_knit_engine_register()
+