help_fun: Display usage of function

Description Usage Arguments Value See Also

View source: R/utils-cliui.R

Description

Display help for a function by arguments usage and examples.

Usage

1
2
3
help_fun(fun, argument_desc = NULL, examples = NULL)

help_fun_(quo_fun, argument_desc = NULL, examples = NULL)

Arguments

fun

a function to be display usage.

argument_desc

a character arguments description.

examples

a character examples.

quo_fun

a function quoted by rlang::quo() or rlang::enquo() to be display usage.

Value

standard output

See Also

Other utils_cliui: interactive_call(), interactive_fun()


chriszheng2016/zstmodelr documentation built on June 13, 2021, 8:59 p.m.