extract_api: Get package data

In r-lib/pkgapi: Map Function Calls

Description

Parse and evaluate code from a package, and store it in an environment, so that we can access it later without parsing it again.

Usage

extract_api(path = ".", targets = character())

Arguments

path	package root
targets	character vector, function call targets to find

Details

We need to evaluate code to get the functions, which might require loading some packages, so we perform all this in a separate R process, using the callr package.

While we are at it, we also check the imports of the package, and return where each function was imported from.

Value

Named list with components:

• name is the package name.

• version is the vesion of the package.

• targets is a character vector, the names of the environments where each target was found.

• functions is a list of functions, with source references.

• exports is a character vector of exported objects.

• s3_methods is a character vector of declared S3 methods.

• imports is a named list of environment names, one for each import.

r-lib/pkgapi documentation built on March 7, 2020, 10:55 a.m.