Variable PACKAGE_RUNTIME`Const`

PACKAGE_RUNTIME: {
    createSearch: () => FlowrSearchBuilder<
        "from",
        [],
        ParentInformation,
        FlowrSearchElements<ParentInformation, (...)[]>,
    >;
    info: {
        certainty: BestEffort;
        defaultConfig: () => { checkWrites: true };
        description: "Finds what makes installing, loading, or running the package fail without doing so: undefined exports, S3 methods without a function, bad NAMESPACE imports, a package attaching itself, tests that never run, test or vignette code that does not parse, missing vignette metadata, and files written into the working directory.";
        name: "Package Runtime";
        tags: readonly [CmdCheck, Bug, Robustness];
    };
    prettyPrint: {
        full: (r: PackageRuntimeResult) => string;
        query: (r: PackageRuntimeResult) => string;
    };
    processSearchResult: (
        _elements: FlowrSearchElements<
            ParentInformation,
            FlowrSearchElement<(...)>[],
        >,
        config: PackageRuntimeConfig,
        data: ReadonlyFlowrAnalysisProvider<KnownParser>,
    ) => Promise<{ ".meta": {}; results: (...)[] }>;
} = ...

The static part of the R CMD check steps that build, install, load, or run the package: what makes installing or loading the namespace fail, what keeps tests and vignettes from running, and what they leave behind.

Type Declaration

ReadonlycreateSearch: () => FlowrSearchBuilder<
    "from",
    [],
    ParentInformation,
    FlowrSearchElements<ParentInformation, (...)[]>,
>
Readonlyinfo: {
    certainty: BestEffort;
    defaultConfig: () => { checkWrites: true };
    description: "Finds what makes installing, loading, or running the package fail without doing so: undefined exports, S3 methods without a function, bad NAMESPACE imports, a package attaching itself, tests that never run, test or vignette code that does not parse, missing vignette metadata, and files written into the working directory.";
    name: "Package Runtime";
    tags: readonly [CmdCheck, Bug, Robustness];
}
ReadonlyprettyPrint: {
full: (r: PackageRuntimeResult) => string;
query: (r: PackageRuntimeResult) => string;
}
ReadonlyprocessSearchResult: (
    _elements: FlowrSearchElements<
        ParentInformation,
        FlowrSearchElement<(...)>[],
    >,
    config: PackageRuntimeConfig,
    data: ReadonlyFlowrAnalysisProvider<KnownParser>,
) => Promise<{ ".meta": {}; results: (...)[] }>

Variable PACKAGE_RUNTIME`Const`

Type Declaration

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

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

`Readonly`processSearchResult: (
    _elements: FlowrSearchElements<
        ParentInformation,
        FlowrSearchElement<(...)>[],
    >,
    config: PackageRuntimeConfig,
    data: ReadonlyFlowrAnalysisProvider<KnownParser>,
) => Promise<{ ".meta": {}; results: (...)[] }>

Settings

Variable PACKAGE_RUNTIMEConst

Type Declaration

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

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

ReadonlyprocessSearchResult: ( _elements: FlowrSearchElements< ParentInformation, FlowrSearchElement<(...)>[], >, config: PackageRuntimeConfig, data: ReadonlyFlowrAnalysisProvider<KnownParser>,) => Promise<{ ".meta": {}; results: (...)[] }>

Settings

Variable PACKAGE_RUNTIME`Const`

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

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

`Readonly`processSearchResult: (
_elements: FlowrSearchElements<
ParentInformation,
FlowrSearchElement<(...)>[],
>,
config: PackageRuntimeConfig,
data: ReadonlyFlowrAnalysisProvider<KnownParser>,
) => Promise<{ ".meta": {}; results: (...)[] }>