uc_help: Help function for 'under_construction'

In LAJordanger/UnderConstruction: Under Construction

Description

It's a pain to write out manually the required "argument-list" approach for the use of under_construction, but this function can be used to fix that.

Usage

uc_help(.uc_fun, high_details_level = FALSE, clean_workspace = FALSE,
  script_files = "")

Arguments

.uc_fun	The function we want to investigate.
high_details_level	Logic value, default FALSE, to be delivered to under_construction.
clean_workspace	Logic value, default FALSE, to be delivered to under_construction.
script_files	Character vector, default "" (i.e. an empty string), to be delivered to under_construction.

Value

This function returns some lines of text, that gives three chunks of code to simplify the setup when working with the function under_construction, i.e. it will create an argument list containing all the arguments of .fun with the default values included, and this list will then be used to feed arguments to the dotsMethods argument of under_construction. Code needed for an inspection of the result is also included.

LAJordanger/UnderConstruction documentation built on May 3, 2019, 5 p.m.