Interface RecoveredPackage

What flowR recovers of a package from its sources: the exports its NAMESPACE states (an exportPattern matched against the names the code defines) and the formals of every function its R/ files define at the top level. This is what an on-demand signature source serves for a package no database knows.

interface RecoveredPackage {
    exported: readonly BrandedIdentifier[];
    functions: readonly DecodedFunction[];
    name: BrandedNamespace;
    origin: string;
    s4Classes: readonly string[];
    version?: string;
}

Index

Properties

exported functions name origin s4Classes version?

Properties

`Readonly`exported

exported: readonly BrandedIdentifier[]

`Readonly`functions

functions: readonly DecodedFunction[]

`Readonly`name

name: BrandedNamespace

`Readonly`origin

origin: string

where the sources came from, like github:masurp/ggmirt

`Readonly`s4Classes

s4Classes: readonly string[]

`Optional` `Readonly`version

version?: string