Display the Argument List of a Function

args

Description

Displays the names of arguments and their default expressions for the specified function.

Usage

args(name)

Arguments

name	a function or a character string specifying the name of a function. Using a character string is useful when the name of the function would not be interpreted as a name by the parser. See the Example section for more information.

Value

returns a copy of name with the function body replaced by NULL. Printing this value reveals the list of arguments and default expressions of the arguments.

Using args can have an advantage over looking at the entire function body in the case of functions with very long bodies.

See Also

formals, help.

Examples

# Arguments for the function "objects"
args(objects) 
# Returns the following: 
#  function(name, pos = -1, envir = as.environment(pos), 
# all.names = FALSE, pattern) NULL
# <environment: base>
# You must specify the argument as a character string for special names. 
# For example:
args("[")
# Returns the following: 
# function() NULL
# <environment: R_GlobalEnv>
# Create new "objects" functions with same arguments
objects.new <- args(objects)
objects.new
# Returns the following: 
#  function(name, pos = -1, envir = as.environment(pos), 
# all.names = FALSE, pattern) NULL
# <environment: base>

Package base version 6.1.1-7
Package Index