Shipped scale definitions — scale_catalog • nestedscales

Packages ship scale definitions as files (see write_scale()) and register the directory holding them; scale_catalog() lists what every registered directory holds and read_scale() takes an id from it. nestedscales registers its own inst/scales/ on load, so read_scale("carriers") works with nothing else attached.

register_scale_dir(path, package = NULL)

list_scale_dirs()

clear_scale_dirs()

scale_catalog()

Arguments

path: A directory of definition files or bundles.
package: The package registering it; NULL for a directory registered by hand (listed under package = NA).

Value

scale_catalog() a data.frame with one row per definition: id, name, kind (the class, without its package prefix), key, frames (joined by /), n_atoms, package, path. register_scale_dir() the registry key, invisibly; list_scale_dirs() a data.frame with package and path; clear_scale_dirs() NULL, invisibly.

Details

register_scale_dir() is what a dimension package calls in its .onLoad(): register_scale_dir(system.file("scales", package = pkgname), package = pkgname).

Examples

scale_catalog()
#>         id     name        kind  key             frames n_atoms      package
#> 1 carriers carriers NestedScale fuel group/carrier/fuel      71 nestedscales
#>                                                                                                     path
#> 1 C:/Users/admin/AppData/Local/Temp/Rtmp0u05lG/temp_libpathb8c47f6a4fa/nestedscales/scales/carriers.json