Registers a board, useful to find resources with pin_find() or pin to additional boards with pin().

board_register(board, name = board, cache = board_cache_path(),
  versions = NULL, ...)

Arguments

board

The name of the board to register.

name

An optional name to identify this board, defaults to the board name.

cache

The local folder to use as a cache, defaults to board_cache_path().

versions

Should this board be registered with support for versions?

...

Additional parameters required to initialize a particular board.

Details

A board requires a local cache to avoid downloading files multiple times. It is recommended to not specify the cache parameter since it defaults to a well known rappdirs. However, you are welcome to specify any other location for this cache or even a temp folder with tempfile(). Notice that, when using a temp folder, pins will be cleared when your R session restarts. The cache parameter can be also set with the pins.path option.

If versions is set to NULL (the default), it will fall back on the board-type-specific default. For instance, local boards do not use versions by default, but GitHub boards do.

See also

Examples

# create a new local board board_register("local", "other_board", cache = tempfile()) # create a Website board board_register("datatxt", name = "txtexample", url = "https://datatxt.org/data.txt", cache = tempfile())