Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update README #19

Merged
merged 2 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
^CRAN-RELEASE$
^\.github$
^CRAN-SUBMISSION$
^man/figures/fuzzyhelp\.gif$
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/felp.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 29 additions & 5 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Binary file added docs/reference/figures/fuzzyhelp.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added man/figures/fuzzyhelp.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading