get.defaults {BTSR} | R Documentation |
Retrieve Default Arguments for BTSR Package Functions
Description
Extracts and displays the default argument values for any function in the BTSR package, including both exported and non-exported functions.
Usage
get.defaults(fun)
Arguments
fun |
Character string specifying the function name to examine (case-sensitive). |
Value
Invisibly returns a data frame with two columns:
-
Argument
: Name of the function parameter -
Default
: Default value or"(no default)"
string if no default exists
The function primarily prints a formatted table of the results to the console.
Examples
## Not run:
# View defaults for BTSR.fit function
get.defaults("BARFIMA.fit")
# Capture the results for later use
defaults <- get.defaults("BARFIMA.fit")
## End(Not run)
[Package BTSR version 1.0.0 Index]