Get the shorthand function call specifications — get_shorthand_functions_from

Given a character vector and the regular expression for the shorthand function call specifications, return an object with the extracted function names and the line numbers where they were found.

Usage

get_shorthand_functions_from_char(
  x,
  bm_shorthand_func_regex = bookmark::opts$get("bm_shorthand_func_regex")
)

Arguments

x: The character vector.
bm_shorthand_func_regex: The shorthand bookmark function call specification regular expression.

Value

A list containing a lists of function call specifications that each contain $lineNrs, $match, and $functionName.

Examples

bookmark::get_shorthand_functions(
  c("First line",
    "<!--[BOOKMARK-FUNCTION::courseDepFunction]-->",
    "Second line",
    "Third line")
);
#> Error: 'get_shorthand_functions' is not an exported object from 'namespace:bookmark'