@eagleoutice/flowr - v2.16.3
    Preparing search index...
    RD_FILES: {
        createSearch: () => FlowrSearchBuilder<
            "from",
            [],
            ParentInformation,
            FlowrSearchElements<ParentInformation, (...)[]>,
        >;
        info: {
            certainty: BestEffort;
            defaultConfig: () => {
                bibentries: true;
                contents: true;
                crossReferences: true;
                docStyle: true;
                examples: true;
                examplesWidth: number;
                extraMacros: (...)[];
                keywords: (...)[];
                lineWidths: true;
                metadata: true;
                minLevel: number;
                parse: true;
                requireValue: false;
                standardKeywords: false;
                uncertainLinks: true;
                usageWidth: number;
            };
            description: "Finds problems in the Rd files: syntax, unknown macros, required and duplicated sections, metadata, cross-references, line widths, contents, and the example code.";
            name: "Rd Files";
            tags: readonly [CmdCheck, Robustness];
        };
        prettyPrint: {
            full: (result: RdFilesResult) => string;
            query: (result: RdFilesResult) => string;
        };
        processSearchResult: (
            _elements: FlowrSearchElements<
                ParentInformation,
                FlowrSearchElement<(...)>[],
            >,
            config: RdFilesConfig,
            data: ReadonlyFlowrAnalysisProvider<KnownParser>,
        ) => { ".meta": { checkedFiles: number }; results: FileResult<(...)>[] };
    } = ...

    Port of the Rd checks of R CMD check, run on the man/*.Rd sources.

    Type Declaration

    • ReadonlycreateSearch: () => FlowrSearchBuilder<
          "from",
          [],
          ParentInformation,
          FlowrSearchElements<ParentInformation, (...)[]>,
      >
    • Readonlyinfo: {
          certainty: BestEffort;
          defaultConfig: () => {
              bibentries: true;
              contents: true;
              crossReferences: true;
              docStyle: true;
              examples: true;
              examplesWidth: number;
              extraMacros: (...)[];
              keywords: (...)[];
              lineWidths: true;
              metadata: true;
              minLevel: number;
              parse: true;
              requireValue: false;
              standardKeywords: false;
              uncertainLinks: true;
              usageWidth: number;
          };
          description: "Finds problems in the Rd files: syntax, unknown macros, required and duplicated sections, metadata, cross-references, line widths, contents, and the example code.";
          name: "Rd Files";
          tags: readonly [CmdCheck, Robustness];
      }
    • ReadonlyprettyPrint: {
          full: (result: RdFilesResult) => string;
          query: (result: RdFilesResult) => string;
      }
    • ReadonlyprocessSearchResult: (
          _elements: FlowrSearchElements<
              ParentInformation,
              FlowrSearchElement<(...)>[],
          >,
          config: RdFilesConfig,
          data: ReadonlyFlowrAnalysisProvider<KnownParser>,
      ) => { ".meta": { checkedFiles: number }; results: FileResult<(...)>[] }