object_from_call: [DEV] Given a call that modifies the R environment, find the...

In hadley/roxygen3: In-source documentation for R

Description

This function is aimed primarily at developers extending this package. You shouldn't need to use it for everyday operation.

Given a call that modifies the R environment, find the object that it creates.

Usage

  object_from_call(call, env, srcref)

Arguments

call	unevaluated function call
env	environment in which to evaluate function call

Details

object_from_call works in a pseudo-S3 manner - given a call like f(a, b, c) it will call object_from_call.f.

Value

a list giving the name and value of the object that the call creates. NULL is returned if the call doesn't modify the package environment in a way that roxygen recognises.

Examples

a <- 1
object_from_call(quote(a <- 1), environment())

hadley/roxygen3 documentation built on May 17, 2019, 12:16 p.m.