params: Function parameters

Description Usage Arguments Details See Also Examples

View source: R/etc.R

Description

Return the parameters of a function, formatted for Roxygen2 use

Usage

1
params(fun, to.clipboard = TRUE)

Arguments

fun

name of function

to.clipboard

logical; should results be copied to the clipboard?

Details

The parameters are returned as "@param <par>" pairs, one per line, as used by Roxygen2. The results can be either printed to console or copied to the clipboard, in either case a character vector will be returned invisibly as well.

See Also

roxdoc

Examples

1
2

AkselA/R-projector documentation built on June 19, 2020, 4:24 p.m.