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

    Interface PackageFiles

    The files of a package that R CMD check sees, and how to read them.

    interface PackageFiles {
        entries: readonly PackageEntry[];
        locate: (
            relative: string,
            line?: number,
            endLine?: number,
        ) => [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ];
        onDisk: boolean;
        read: (relative: string) => string | undefined;
        root: string;
    }
    Index
    entries locate onDisk read root
    entries: readonly PackageEntry[]

    every file and directory that survives R CMD build, the root itself excluded

    locate: (
        relative: string,
        line?: number,
        endLine?: number,
    ) => [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ]

    a location naming the file (and optionally a line) for a finding

    onDisk: boolean

    whether the listing comes from the file system (and is hence complete), not just from the files flowR knows

    read: (relative: string) => string | undefined

    the text of a file given relative to the root, undefined if it does not exist or cannot be read

    root: string

    the package root (the folder of the DESCRIPTION)

    Settings
    Member Visibility

    On This Page
    Properties