@eagleoutice/flowr - v2.13.14
    Preparing search index...

    Interface SignatureFunctionView

    the detailed view of a single function within a package

    interface SignatureFunctionView {
        callees: readonly string[];
        callGraph?: string;
        docUrl?: string;
        exported: boolean;
        file?: string;
        flowr?: SignatureFlowrView;
        flowrOnly?: boolean;
        line?: number;
        manUrl?: string;
        name: string;
        package: string;
        parameters: readonly SignatureParameterView[];
        properties: readonly string[];
        s3generic?: boolean;
        s3method?: { class: string; generic: string; package: string };
        s3methods?: readonly string[];
        sourceUrl?: string;
        version?: string;
    }
    Index
    callees callGraph? docUrl? exported file? flowr? flowrOnly? line? manUrl? name package parameters properties s3generic? s3method? s3methods? sourceUrl? version?
    callees: readonly string[]
    callGraph?: string

    a mermaid.live link visualizing the transitive call graph from this function (only when requested with --cg)

    docUrl?: string

    best-effort rdrr.io documentation link, when the function name maps to a documentable topic

    exported: boolean
    file?: string
    flowr?: SignatureFlowrView

    what flowR itself states about the function, from the built-in environment of the analysis

    flowrOnly?: boolean

    whether the whole view comes from flowR's built-in definition because the database has no entry: the primitives and operators (+, [, if) that appear in no package's sources, and anything a flowR configuration adds. Everything the database would contribute (defaults, callees, location) is then empty, and since flowR records no defaults, every SignatureParameterView.required reads false.

    line?: number
    manUrl?: string

    link to the .Rd help source at the queried version, which docUrl cannot offer (rdrr.io only serves the current release)

    name: string
    package: string
    parameters: readonly SignatureParameterView[]
    properties: readonly string[]
    s3generic?: boolean

    whether the function looks like an S3 generic (has <generic>.<class> dispatch targets in the same package)

    s3method?: { class: string; generic: string; package: string }

    when the function is an S3 method, the generic it dispatches for (print.rema is print in base, class rema); lazily computed

    s3methods?: readonly string[]

    the <generic>.<class> dispatch targets found in the same package

    sourceUrl?: string

    deep link to the definition on the read-only GitHub mirror of the sources (CRAN, or R's own for a base package)

    version?: string

    Settings
    Member Visibility

    On This Page
    Properties