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

    Interface PackageStructureConfig

    interface PackageStructureConfig {
        builtPackage: boolean;
        checkBashisms: boolean;
        checkFutureTimestamps: boolean;
        checkTopLevel: boolean;
        cranKnownHidden: readonly string[];
        cranPack: boolean;
        docDirsNotInstalled: readonly string[];
        hiddenAllowed: readonly string[];
        leftoverExtensions: readonly string[];
        maxInstalledSizeMb: number;
        maxPathLength: number;
        maxPdfBytes: number;
        reservedInstDirs: readonly string[];
        standardTopLevel: readonly string[];
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index
    builtPackage checkBashisms checkFutureTimestamps checkTopLevel cranKnownHidden cranPack docDirsNotInstalled hiddenAllowed leftoverExtensions maxInstalledSizeMb maxPathLength maxPdfBytes reservedInstDirs standardTopLevel
    builtPackage: boolean

    whether the package is a built tarball (so inst/doc is expected to hold the vignette outputs)

    checkBashisms: boolean

    whether to flag /bin/bash and env bash in configure and cleanup (off in R CMD check by default)

    checkFutureTimestamps: boolean

    whether to flag files and directories modified in the future (R CMD check does with --as-cran)

    checkTopLevel: boolean

    whether to check for non-standard top-level files and directories (R CMD check does with --as-cran)

    cranKnownHidden: readonly string[]

    names of hidden files and directories the CRAN package checks know about

    cranPack: boolean

    whether to say for each hidden file whether the CRAN package checks know about it

    docDirsNotInstalled: readonly string[]

    the directories of inst/doc that should not be installed

    hiddenAllowed: readonly string[]

    hidden files and directories (as paths relative to the package root) that are fine

    leftoverExtensions: readonly string[]

    the extensions (without dot) of files that are leftovers when found next to vignettes

    maxInstalledSizeMb: number

    the installed package size in Mb above which a note is given (default 5)

    maxPathLength: number

    a path of more than this many bytes (with the package name as prefix) is noted (default 100)

    maxPdfBytes: number

    a PDF in inst/doc of more bytes than this is flagged to be compacted (default 1 MiB)

    reservedInstDirs: readonly string[]

    the directories of inst that R uses itself

    standardTopLevel: readonly string[]

    the files and directories that may be at the top level of a package

    Settings
    Member Visibility

    On This Page
    Properties