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

    Interface S4UseConfig

    Which arguments of a call name S4 registrations it depends on rather than declares.

    interface S4UseConfig {
        classArgs?: readonly ClassArgRef[];
        genericArg?: ClassArgRef;
        genericSuffix?: string;
        instantiates?: { initializer: BrandedIdentifier };
        registersArg?: ClassArgRef;
        registersMethod?: boolean;
        returnsMethod?: boolean;
    }

    Hierarchy (View Summary)

    Index
    classArgs? genericArg? genericSuffix? instantiates? registersArg? registersMethod? returnsMethod?
    classArgs?: readonly ClassArgRef[]

    the arguments naming S4 classes the call uses (Class in new, signature in setMethod)

    genericArg?: ClassArgRef

    the argument naming the S4 generic the call answers or asks about (f in setMethod)

    genericSuffix?: string

    appended to the generic named by genericArg (setReplaceMethod("f", ...) answers f<-)

    instantiates?: { initializer: BrandedIdentifier }

    the call creates an instance of the classes its classArgs name, running the methods of the initializer generic and their validity functions

    registersArg?: ClassArgRef

    the argument naming an S4 class the call adds to without declaring it (to in setAs): read and registered anew, so a later use depends on this call as well as on the declaration

    registersMethod?: boolean

    the call registers its definition as a method of the generic, for the signature the first of its classArgs states (setMethod)

    returnsMethod?: boolean

    the call hands back a method of the generic its genericArg names (getMethod, selectMethod)

    Settings
    Member Visibility

    On This Page
    Properties