@eagleoutice/flowr - v2.16.3
    Preparing search index...
    interface RdFilesConfig {
        bibentries: boolean;
        contents: boolean;
        crossReferences: boolean;
        docStyle: boolean;
        examples: boolean;
        examplesWidth: number;
        extraMacros: readonly string[];
        keywords: readonly string[];
        lineWidths: boolean;
        metadata: boolean;
        minLevel: number;
        parse: boolean;
        requireValue: boolean;
        standardKeywords: boolean;
        uncertainLinks: boolean;
        usageWidth: number;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index
    bibentries: boolean

    report bibentries a page cites but does not show

    contents: boolean

    report missing descriptions and values, argument items without text, and generated boilerplate

    crossReferences: boolean

    report links to topics no page or package provides

    docStyle: boolean

    report S3 methods a \usage calls by their full name instead of with \method

    examples: boolean

    parse the examples and report their syntax errors, undefined calls, T and F, q(), and the files they write

    examplesWidth: number

    the widest line an \examples section may have

    extraMacros: readonly string[]

    Rd macro files to load besides those of the package

    keywords: readonly string[]

    the keywords besides the standard ones a page may use

    lineWidths: boolean

    report lines in \usage and \examples wider than RdFilesConfig#usageWidth and RdFilesConfig#examplesWidth

    metadata: boolean

    report duplicate names and aliases, names that differ only by case, and pages without any alias

    minLevel: number

    drop parser diagnostics below this checkRd level, the messages of prepare_Rd are always kept

    parse: boolean

    report what the Rd parser of R reports: syntax errors, unknown macros, and unexpected sections

    requireValue: boolean

    report functions documented without a \value section

    standardKeywords: boolean

    report keywords that are neither standard nor in RdFilesConfig#keywords

    uncertainLinks: boolean

    also report links whose target flowR cannot decide

    usageWidth: number

    the widest line a \usage section may have