xkd_read: Read an Excalidraw file

In baptiste/minixcali: Excalidraw Document Builder

Read an Excalidraw file

Description

Read an Excalidraw file from a file or URL. If simplifyVector = TRUE, the the diagram elements are returned as a data frame instead of a list. This option makes the returned object is incompatible with the R6 methods in this package.

Usage

xkd_read(file, excalidoc = FALSE, simplifyVector = FALSE)

Arguments

file	A file path or URL for an Excalidraw file with a JSON or excalidraw file extension.
excalidoc	Default FALSE. If TRUE, return a R6 ExcaliDoc class object.
simplifyVector	simplifies nested lists into vectors and data frames. See fromJSON().

Value

A named list or ExcaliDoc object

baptiste/minixcali documentation built on April 4, 2024, 2:10 a.m.