Get and process the bookmarks from a single file

"Bookmarks" are embedded (meta)data and function calls in the bookmark format. This function parses a file and extract the bookmarks.

Usage

bm_get_bookmarks_from_file(
  x,
  path = NULL,
  encoding = bookmark::opts$get("encoding"),
  silent = bookmark::opts$get("silent")
)

Arguments

x

The filename

Value

An object of class bookmarks_from_file, a list containing the parsed data as well as all intermediate steps.

Details

Note that end users normally do not use this function.

Examples

systemPath <-
  system.file("extdata",
    package = "bookmark"
  );

bookmark::bm_get_bookmarks_from_file(
  file.path(systemPath, "bookmark-testdoc-1.qmd")
);
#> Error in bookmark::bm_get_bookmarks_from_file(file.path(systemPath, "bookmark-testdoc-1.qmd")): You passed file '/bookmark-testdoc-1.qmd' to read from, but it does not exist!