Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

inspect_args

Inspect the argument section of an Rd object


Description

Inspect the argument section of an Rd object.

Usage

inspect_args(rdo, i_usage)

Arguments

rdo

an Rd object describing functions.

i_usage

see Details.

Details

inspect_args checks if the arguments in the documentation object rdo match the (union of) the actual arguments of the functions it describes.

If i_usage is missing, it is computed by inspecting the current definitions of the functions described in rdo, see inspect_usage. This argument is likely to be supplied if the function calling inspect_args has already computed it for other purposes.

Value

TRUE if the arguments in the documentation match the (union of) the actual arguments of the described functions, FALSE otherwise.

The returned logical value has attribute ‘details’ which is a list with the following components.

rdo_argnames

arguments described in the documentation object, rdo.

cur_argnames

arguments in the current definitions of the described functions.

added_argnames

new arguments

removed_argnames

removed (dropped) arguments.

Author(s)

Georgi N. Boshnakov


Rdpack

Update and Manipulate Rd Documentation Objects

v2.1.1
GPL (>= 2)
Authors
Georgi N. Boshnakov [aut, cre], Duncan Murdoch [ctb]
Initial release
2021-02-19

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.