flyhelp: Show the documentation for a flydoc function

Description Usage Arguments Examples

View source: R/flyhelp.R

Description

This builds and shows the documentation for a function that has been documented using flydoc

Usage

1
  flyhelp(fun)

Arguments

fun

The function to show the flydoc for

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
myfun <- function(x, y){
   x + y
}
Title(myfun) <- "My crazy function"
Description(myfun) <- "This function is a crazy function"
Arguments(myfun) <- c(x = "Value 1 to add", y = "Value 2 to add")
Return(myfun) <- "The sum of x and y"
Details(myfun) <- "This uses some pretty advanced math. You might need to read up on arithmetic"
Examples(myfun) <- "myfun(1, 2)"
## Not run: 
flyhelp(myfun)

## End(Not run)

Dasonk/flydoc documentation built on May 6, 2019, 1:37 p.m.