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

    Interface SignatureQuery

    Inspects the loaded signature database(s) (see the Database wiki). The package and function fields accept glob wildcards (*, ?), and version accepts an exact version, a glob (3.*), a semver range (>=3.0.0, 3.x), or a release-date bound (<=2026, >=2021.05, YYYY.MM.DD). With no package it summarizes the loaded databases; a single exact package/function yields the full view (signature, definition location, CRAN-mirror source link); a wildcard yields the matching set. parameters and requiredParameters further filter to functions that have a parameter matching every given name (position-independent) or an exact required-parameter count (a parameter filter alone, e.g. --param fuzz, searches every package; repeat --param or comma-separate to require several, e.g. --param data --param mapping).

    Wherever no loaded database records a name, flowR's own built-in configuration answers instead, so the query still says something with no database mounted at all. Every such answer is marked (flowrOnly on a function or a match, SignatureQueryResult.builtInSuggestions for a suggestion) and states no version, location, or export status, as the configuration records none of those.

    interface SignatureQuery {
        callGraph?: boolean;
        callGraphMaxNodes?: number;
        function?: string;
        package?: string;
        parameters?: readonly string[];
        requiredParameters?: number;
        type: "signature";
        version?: string;
    }

    Hierarchy (View Summary)

    Index
    callGraph? callGraphMaxNodes? function? package? parameters? requiredParameters? type version?
    callGraph?: boolean

    for a single function, also render its transitive call graph as a mermaid.live link (--cg)

    callGraphMaxNodes?: number

    How many nodes the rendered call graph may hold before the expansion stops (default DefaultCallGraphMaxNodes). Cross-package expansion would otherwise run off into base R, and a graph nobody can read is not an answer. --cg-max <n> sets it.

    function?: string

    the function/symbol within package to inspect (glob wildcards allowed)

    package?: string

    the package to inspect (glob wildcards allowed); omit for a summary of the loaded databases

    parameters?: readonly string[]

    keep only functions that have a parameter matching every one of these names (glob wildcards allowed, position-independent, e.g. fuzz, .*data)

    requiredParameters?: number

    keep only functions with exactly this many required (no-default) parameters, excluding ...

    type: "signature"

    used to select the query type :)

    version?: string

    a version spec: an exact version, a glob (3.*), a semver range (>=3.0.0, 3.x), or a release-date bound (<=2026, >=2021.05 in YYYY.MM.DD)

    Settings
    Member Visibility

    On This Page
    Properties