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

```{css, echo = FALSE} h1 { color: darkblue; }

```r
knitr::opts_chunk$set(
  collapse = FALSE,
  comment = "",
  class.output = "text"
)

library(felp)
library(printr) # To include documents output by `?` in this article

The felp package provides

• 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
• the felp function and ? operator to extend help and ? in the utils package by displaying structure of an object

Syntax

# ? as a prefix operator
?help
?utils::help

# ?. as a pseudo postfix operator for functions and objects
help?.
utils::help?.

# ?p as a pseudo postfix operator fur packages
utils?p

# felp as an extention of utils::help
felp(help)
felp("help")
felp(utils::help)
felp(help, utils)
felp(package = utils)

felp(function)

felp?. # and `felp(felp)` return source and document of `felp` function

felp(dataset)

dummy?. # and `felp(dummy)` return sructure and document of `dummy` dataset.

felp(package)

felp?p # and `felp(package = felp)` return document of `felp` package

atusy/felp documentation built on Aug. 12, 2024, 6:44 p.m.