Interface PackageCode

A piece of R code of a package that does not live in R/, but which R CMD check still runs (or reads).

interface PackageCode {
    code: string;
    depends?: readonly string[];
    file: string;
    lineOffset: number;
    origin: CodeOrigin;
}

Properties

code: string

the code itself, with the lines that are no R code blanked so that line numbers stay as they are in the file

depends?: readonly string[]

for a vignette, the packages its %\VignetteDepends{} names and the package of its %\VignetteEngine{}

file: string

the file the code is taken from, relative to the package root

lineOffset: number

the line of file the first line of code is on