The goal of {shinidraw} is to bring the amazing
Exaclidraw to your R console.
You can install the development version of {shinidraw} like so:
pak::pak("thinkr-open/shinidraw")Excalidraw is awesome, and we’ve been using it for prototyping {shiny}
apps for a while now. So what is missing, and what does {shinidraw}
bring to the table?
When used in the browser, Excalidraw saves your drawings in your browser’s local storage, and you can export and save locally.
When using {shinidraw}, you’ll have a built-in project system, where
the .excalidraw files are stored on the machine running the app.
If you develop in an existing project, {shinidraw} will load the
latest version of the .excalidraw file.
Here are the commands you can use to manage your projects:
library(shinidraw)
# Create an empty, temp file (will not be saved)
excalidraw()
# This will create a new project
excalidraw_new_project()
# This will open an existing project
excalidraw_open_project("rr-2023")
# Simply open a file
(file <- excalidraw_helloworld())
excalidraw_open_file(
file
)Note that the first time you launch {shinidraw}, it will prompt for
your consent to store data on your computer.
The app will auto-save your drawings at a given interval, so you don’t have to worry about losing your work.
You’re reading the doc about version: 0.0.0.9006
This README has been compiled on the
Sys.time()
#> [1] "2023-06-21 15:01:56 CEST"Here are the test & coverage results:
devtools::check(quiet = TRUE)
#> ℹ Loading shinidraw
#> ── R CMD check results ─────────────────────────────── shinidraw 0.0.0.9006 ────
#> Duration: 10.4s
#>
#> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔covr::package_coverage()
#> shinidraw Coverage: 58.75%
#> R/run_app.R: 0.00%
#> R/excalidraw_existing_project.R: 13.54%
#> R/mod_excalidraw.R: 60.78%
#> R/get_excalidraw_path.R: 66.67%
#> R/consent.R: 77.78%
#> R/golem_utils_server.R: 84.62%
#> R/golem_utils_ui.R: 89.57%
#> R/app_ui.R: 92.00%
#> R/app_config.R: 100.00%
#> R/app_server.R: 100.00%
#> R/excalidraw_dependency.R: 100.00%
#> R/utils_examples.R: 100.00%Please note that the shinidraw project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.