Skip to content

Commit

Permalink
docs(README): mention online versions of help search engine
Browse files Browse the repository at this point in the history
  • Loading branch information
atusy committed Aug 5, 2024
1 parent 50849db commit e123cfd
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,22 @@ source("https://install-github.me/atusy/felp")

### Fuzzy search and preview of help

with `felp::fuzzyhelp()` or "Fuzzy Search on R Help" RStudio Addin
with `felp::fuzzyhelp()` or "Fuzzy Search on R Help" RStudio Addin:

![Fuzzy search and preview of help](https://felp.atusy.net/reference/figures/fuzzyhelp.gif)

This feature is a [https://shiny.posit.co/](Shiny) app and is also available online at <https://atusy.shinyapps.io/fuzzyhelp/>.
Note that some features are disabled in the online version (e.g., links between help topics and syntax highlights).
Also, the online version has a limit on the number of available packages (**tidyverse** + **felp**).

There is also a similar project at <https://helpr.atusy.net/> based on [WebR].
The main differences are appearance and the number of available packages.
[WebR]-based project supports installing any package on CRAN.
Once you type `{{ packageName }}::` (e.g., `dplyr::`), [WebR] installs the package and you can find help topics in the package (e.g., `dplyr::mutate`).

[WebR]: https://docs.r-wasm.org/webr/latest/


### Enhanced alternatives of base features

``` r
Expand Down

0 comments on commit e123cfd

Please sign in to comment.