add_datalist Add a ‘datalist’ File to a Source Package

Description

The data() command with no arguments lists all the datasets available via data in attached packages, and to do so a per-package list is installed. Creating that list at install time can be slow for packages with huge datasets, and can be expedited by a supplying ‘data/datalist’ file.

Usage

add_datalist(pkgpath, force = FALSE, small.size = 1024^2)

Arguments

pkgpath	The path to a (source) package.
force	logical: can an existing ‘data/datalist’ file be over-written?
small.size	number: a ‘data/datalist’ file is created only if the total size of the data files is larger than small.size bytes.

Details

R CMD build will call this function to add a data list to packages with 1MB or more of file in the ‘data’ directory.

It can also be also helpful to give a ‘data/datalist’ file in packages whose datasets have many dependencies, including loading the packages itself (and maybe others).

See Also

data.

The ‘Writing R Extensions’ manual.