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

    Variable PACKAGE_RUNTIMEConst

    PACKAGE_RUNTIME: {
        createSearch: () => FlowrSearchBuilder<
            "from",
            [],
            ParentInformation,
            FlowrSearchElements<ParentInformation, (...)[]>,
        >;
        info: {
            certainty: BestEffort;
            defaultConfig: () => {
                checkExports: true;
                checkWrites: true;
                requireExports: true;
            };
            description: "Finds what makes installing, loading, or running the package fail without doing so: undefined exports, export patterns matching nothing, a NAMESPACE exporting nothing, 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, metadata: unknown) => string;
            query: (r: PackageRuntimeResult, metadata: unknown) => string;
        };
        processSearchResult: (
            _elements: unknown,
            config: PackageRuntimeConfig,
            data: ReadonlyFlowrAnalysisProvider,
        ) =>
            | PromiseLike<{ ".meta": ...; results: ... }>
            | { ".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: () => {
              checkExports: true;
              checkWrites: true;
              requireExports: true;
          };
          description: "Finds what makes installing, loading, or running the package fail without doing so: undefined exports, export patterns matching nothing, a NAMESPACE exporting nothing, 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, metadata: unknown) => string;
          query: (r: PackageRuntimeResult, metadata: unknown) => string;
      }
    • ReadonlyprocessSearchResult: (
          _elements: unknown,
          config: PackageRuntimeConfig,
          data: ReadonlyFlowrAnalysisProvider,
      ) =>
          | PromiseLike<{ ".meta": ...; results: ... }>
          | { ".meta": {}; results: (...)[] }

    Settings
    Member Visibility