List the signatures of all functions

Share:

Description

Lists the signatures of all functions in an environment or file.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
list_sigs(x, pattern = NULL, ...)

## Default S3 method:
list_sigs(x, ...)

## S3 method for class 'environment'
list_sigs(x, pattern = NULL, ...)

## S3 method for class 'character'
list_sigs(x, ...)

Arguments

x

An environment or the the path to a file.

pattern

An optional regular expression. Only names matching pattern are returned.

...

Currently ignored

Value

An object of class siglist, which is a list of sig obejcts.

Examples

1
2
3
4
5
6
#From a package
list_sigs(pkg2env(graphics))
#Just functions beginning with 'a'.
list_sigs(pkg2env(graphics), pattern = "^a")
#From a file
list_sigs(system.file("extdata", "sample.R", package = "sig"))