showArgs: Display Expected Widget Arguments

View source: R/supportFuns.r

showArgsR Documentation

Display Expected Widget Arguments

Description

For each widget specified, display its arguments in order with their default values. The display list can be expanded to report each argument on a single line.

Usage

showArgs(widget, width=70, showargs=FALSE)

Arguments

widget

vector string of widget names; if not specified (default), the function displays information about all widgets in alphabetical order.

width

numeric width used by strwrap to wrap lines of the widget usage section.

showargs

logical:, if TRUE, the display also lists each argument on single line after the widget usage section.

Value

A text stream to the R console. Invisibly returns the widget usage lines.

Author(s)

Alex Couture-Beil, Vancouver Island University, Nanaimo BC


PBSmodelling documentation built on Nov. 9, 2023, 5:07 p.m.