uc_help_call: Help function for 'under_construction', using a call

Description Usage Arguments Value

View source: R/uc_help_call.R

Description

A help function similar to uc_help, but based on a call (typically captured inside of some other function under investigation).

Usage

1
2
uc_help_call(.uc_call, .save_file = NULL, high_details_level = FALSE,
  clean_workspace = FALSE, script_files = "")

Arguments

.uc_call

The call we want to investigate, the name of the function will be extracted from this.

.save_file

A character string, to be used for the name of the file to which .uc_call will be saved. The default value NULL will trigger the creation of a file name based on the function-part of .uc_call.

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 saves .uc_call to file and gives a line of code needed to source it back. In addition it returns 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 values from .uc_call and default values included, and this list will then be used to feed arguments to the dotsMethods argument of under_construction. Some code needed for an inspection of the result is also included.


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