leadingS3generic: check whether function name is an S3 generic

In inlinedocs: Convert inline comments to documentation

Description

Determines whether a function name looks like an S3 generic function

Usage

leadingS3generic(name, env, ...)

Arguments

name	name of function
env	environment to search for additional generics
...	ignored here

Details

This function is one of the default parsers, but exposed as possibly of more general interest. Given a function name of the form x.y.z it looks for the generic function x applying to objects of class y.z and also for generic function x.y applying to objects of class z.

Assumes that the first name which matches any known generics is the target generic function, so if both x and x.y are generic functions, will assume generic x applying to objects of class y.z

Value

If a matching generic found returns a list with a single component:

.s3method

a character vector containing generic name and object name.

If no matching generic functions are found, returns an empty list.

Author(s)

Toby Dylan Hocking <[e-mail]> [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]

inlinedocs documentation built on May 2, 2019, 4:44 p.m.