fuzzyhelp: Fuzzily Search Help and View the Selection

In felp: Functional Help for Functions, Objects, and Packages

Fuzzily Search Help and View the Selection

Description

Users no more have to afraid of exact name of the object they need help. A shiny gadget helps you to find a topic fuzzily. Click radio buttons to switch preview contents. Click "Done" or "Cancel" to close the widget. The "Done" button will also hook help function on the selection.

Usage

fuzzyhelp(query = "", method = getOption("fuzzyhelp.method", "fzf"))

Arguments

query	An initial query to search for the help system.
method	A fuzzy match method to use. Choices are "fzf" and "lv" (levenstein). The method "lv" is faster but can be less accurate. The default value can be tweaked by options(fuzzyhelp.method = "lv").

Note

The default fuzzy match algorithm is a simplified version of https://github.com/junegunn/fzf. The implementation in this package excludes bonuses from relationship with matched characters and their previous characters.

Examples

if (FALSE) {
  fuzzyhelp()
}

felp documentation built on Oct. 9, 2022, 5:05 p.m.