diff --git a/.Rbuildignore b/.Rbuildignore index e573139..ef09dda 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -11,3 +11,4 @@ ^CRAN-RELEASE$ ^\.github$ ^CRAN-SUBMISSION$ +^man/figures/fuzzyhelp\.gif$ diff --git a/README.md b/README.md index ba81935..5873cfb 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,13 @@ `felp` is a short of **f**unctional h**elp**, and provides -- fuzzy search and preview of help with `fuzzyhelp` function or "Fuzzy Search on R Help" RStudio Addin -- the `?.` pseudo-post fix operator to simultaneously display a help document - and a structure of an object -- the `?p` pseudo-post fix operator to display document of a package - -and more in [Syntax](#Syntax) and [Get started](https://felp.atusy.net/articles/felp.html) +- [fuzzy search and preview of help](fuzzy-search-and-preview-of-help) + - with `fuzzyhelp` function or "Fuzzy Search on R Help" RStudio Addin +- [Enhanced alternatives of base features](#enhanced-alternatives-of-base-features) + - `?.` pseudo-postfix operator to simultaneously display a help document + and a structure of an object + - `?p` pseudo-postfix operator to display document of a package + - and more ## Installation @@ -30,7 +31,15 @@ install.packages("felp") source("https://install-github.me/atusy/felp") ``` -## Syntax +## Features + +### Fuzzy search and preview of help + +with `fuzzyhelp()` or "Fuzzy Search on R Help" RStudio Addin + +![Fuzzy search and preview of help](man/figures/fuzzyhelp.gif) + +### Enhanced alternatives of base features ``` r # ? operator diff --git a/docs/articles/felp.html b/docs/articles/felp.html index 673188b..6062172 100644 --- a/docs/articles/felp.html +++ b/docs/articles/felp.html @@ -323,7 +323,7 @@

felp(package)fuzzy search and preview of help + + +
  • +Enhanced alternatives of base features + +
  • -

    and more in Syntax and Get started

    Installation

    @@ -107,8 +119,19 @@

    From GitHub -

    Syntax +

    Features

    +
    +

    Fuzzy search and preview of help +

    +

    with fuzzyhelp() or “Fuzzy Search on R Help” RStudio Addin

    +
    +Fuzzy search and preview of help
    Fuzzy search and preview of help
    +
    +
    +
    +

    Enhanced alternatives of base features +

     # ? operator
     ?help
    @@ -128,6 +151,7 @@ 

    Syntax felp(help, utils) felp(package = utils)

    +

    diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index c328fb4..ec1c903 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -3,5 +3,5 @@ pkgdown: 2.0.7 pkgdown_sha: ~ articles: felp: felp.html -last_built: 2024-03-27T15:39Z +last_built: 2024-03-28T00:10Z diff --git a/docs/reference/figures/fuzzyhelp.gif b/docs/reference/figures/fuzzyhelp.gif new file mode 100644 index 0000000..138758b Binary files /dev/null and b/docs/reference/figures/fuzzyhelp.gif differ diff --git a/man/figures/fuzzyhelp.gif b/man/figures/fuzzyhelp.gif new file mode 100644 index 0000000..138758b Binary files /dev/null and b/man/figures/fuzzyhelp.gif differ