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

    Interface LibraryProcessorConfig

    Controls how processLibrary brings a package into scope.

    interface LibraryProcessorConfig {
        ambient?: AmbientStateAccess | readonly AmbientStateAccess[];
        boxUse?: boolean;
        characterOnly?: boolean;
        dispatches?: string[];
        evaluatedIn?: string;
        formals?: readonly BrandedIdentifier[];
        frame?: number;
        fromImports?: boolean;
        hasUnknownSideEffects?: boolean | LinkTo<string | RegExp>;
        keepEnvironment?: boolean;
        namesInDots?: boolean;
        namespaceOnly?: boolean;
        packagesInDots?: boolean;
        props?: number;
        scope?: AmbientScope;
        sig?: FnSig;
        signals?: readonly string[];
        stripRepo?: boolean;
        tags?: SemanticCallTags;
    }

    Hierarchy (View Summary)

    Index
    ambient? boxUse? characterOnly? dispatches? evaluatedIn? formals? frame? fromImports? hasUnknownSideEffects? keepEnvironment? namesInDots? namespaceOnly? packagesInDots? props? scope? sig? signals? stripRepo? tags?
    ambient?: AmbientStateAccess | readonly AmbientStateAccess[]

    how the call reads or writes global state like the graphics parameters, the options, or files, see AmbientStateAccess

    boxUse?: boolean

    box::use(pkg[a, b]): attach only the symbols listed in the [...] bracket

    characterOnly?: boolean

    the package argument is evaluated, not taken as a symbol (requireNamespace/loadNamespace/attachNamespace, unlike library)

    dispatches?: string[]

    the generics the call may dispatch to on (parts of) its arguments, like as.character for paste or format for the columns print shows of a data frame; any method of them may run

    evaluatedIn?: string

    a formal whose value always names packages, like pacman::p_load(char = pkgs)

    formals?: readonly BrandedIdentifier[]

    the formals in order, the first one naming the package, for a loader whose other formals differ from library's

    frame?: number

    What this call lets the function around it reach about its own formals without naming one of them, e.g. match.call() (ArgProp.Nse) or nargs() (ArgProp.Presence); see reflectiveRolesOf.

    fromImports?: boolean

    import::from(pkg, a, b): attach only the symbols named in the call

    hasUnknownSideEffects?: boolean | LinkTo<string | RegExp>
    keepEnvironment?: boolean

    keep the environment on the call vertex, for a later pass to look names up in

    namesInDots?: boolean

    with packagesInDots, the name of a named argument names a package as well, needs::needs(dplyr = "1.0")

    namespaceOnly?: boolean

    requireNamespace("pkg") / loadNamespace("pkg"): load without attaching bare names

    packagesInDots?: boolean

    every unnamed argument names a package (pacman::p_load(a, b)), as the formals after ... only match by name

    props?: number

    the bitfield of CallProp

    scope?: AmbientScope

    the call changes that state for a scope only, see AmbientScope

    sig?: FnSig

    the parameters and what each of their arguments is used for

    signals?: readonly string[]

    The condition classes a call signals when every argument it is handed is a constant, like simpleError, error, and condition for stop("x").

    stripRepo?: boolean

    a package may be given as user/repo (librarian::shelf), naming repo

    tags?: SemanticCallTags

    the array of SemanticCallTag

    Settings
    Member Visibility

    On This Page
    Properties