Variable S3_METHOD_CONSISTENCY`Const`

S3_METHOD_CONSISTENCY: {
    createSearch: () => FlowrSearchBuilder<
        "from-query",
        [],
        ParentInformation,
        FlowrSearchElements<ParentInformation, (...)[]>,
    >;
    info: {
        certainty: BestEffort;
        defaultConfig: () => {
            checkApparentMethods: true;
            checkMethods: true;
            checkReplacementValues: true;
            checkUnregistered: true;
        };
        description: "Finds S3 methods whose formals do not match their generic, methods not registered in the NAMESPACE, and replacement functions whose last formal is not `value`.";
        name: "S3 Method Consistency";
        tags: readonly [CmdCheck, Bug, Robustness];
    };
    prettyPrint: {
        full: (r: S3MethodConsistencyResult) => string;
        query: (r: S3MethodConsistencyResult) => string;
    };
    processSearchResult: (
        _elements: FlowrSearchElements<
            ParentInformation,
            FlowrSearchElement<(...)>[],
        >,
        config: S3MethodConsistencyConfig,
        data: ReadonlyFlowrAnalysisProvider<KnownParser>,
    ) => Promise<
        {
            ".meta": { consideredMethods: ...; consideredReplacements: ... };
            results: (...)[];
        },
    >;
} = ...

Port of the R CMD check checks checking S3 generic/method consistency (tools::checkS3methods) and checking replacement functions (tools::checkReplaceFuns). A method must take all the arguments of its generic in the same order (and ... if the generic does); a replacement function must end in value. The methods are the S3method() registrations of the NAMESPACE (certain) and the functions named generic.class for a generic (uncertain, R CMD check merely lists these on request). The generics are the package's own functions calling UseMethod, the group generics, and the functions flowR knows as generic with their formals; a function flowR knows as an ordinary function (t.test) is no method of t. Additionally, apparent methods that are exported but not registered are reported.

Type Declaration

ReadonlycreateSearch: () => FlowrSearchBuilder<
    "from-query",
    [],
    ParentInformation,
    FlowrSearchElements<ParentInformation, (...)[]>,
>
Readonlyinfo: {
    certainty: BestEffort;
    defaultConfig: () => {
        checkApparentMethods: true;
        checkMethods: true;
        checkReplacementValues: true;
        checkUnregistered: true;
    };
    description: "Finds S3 methods whose formals do not match their generic, methods not registered in the NAMESPACE, and replacement functions whose last formal is not `value`.";
    name: "S3 Method Consistency";
    tags: readonly [CmdCheck, Bug, Robustness];
}
ReadonlyprettyPrint: {
full: (r: S3MethodConsistencyResult) => string;
query: (r: S3MethodConsistencyResult) => string;
}
ReadonlyprocessSearchResult: (
    _elements: FlowrSearchElements<
        ParentInformation,
        FlowrSearchElement<(...)>[],
    >,
    config: S3MethodConsistencyConfig,
    data: ReadonlyFlowrAnalysisProvider<KnownParser>,
) => Promise<
    {
        ".meta": { consideredMethods: ...; consideredReplacements: ... };
        results: (...)[];
    },
>

Variable S3_METHOD_CONSISTENCY`Const`

Type Declaration

`Readonly`createSearch: () => FlowrSearchBuilder<
    "from-query",
    [],
    ParentInformation,
    FlowrSearchElements<ParentInformation, (...)[]>,
>

`Readonly`prettyPrint: {
full: (r: S3MethodConsistencyResult) => string;
query: (r: S3MethodConsistencyResult) => string;
}

Settings

Variable S3_METHOD_CONSISTENCYConst

Type Declaration

ReadonlycreateSearch: () => FlowrSearchBuilder< "from-query", [], ParentInformation, FlowrSearchElements<ParentInformation, (...)[]>,>

ReadonlyprettyPrint: { full: (r: S3MethodConsistencyResult) => string; query: (r: S3MethodConsistencyResult) => string;}

Settings

Variable S3_METHOD_CONSISTENCY`Const`

`Readonly`createSearch: () => FlowrSearchBuilder<
"from-query",
[],
ParentInformation,
FlowrSearchElements<ParentInformation, (...)[]>,
>

`Readonly`prettyPrint: {
full: (r: S3MethodConsistencyResult) => string;
query: (r: S3MethodConsistencyResult) => string;
}