pins (version 0.1.1)

board_register: Register Board

Description

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

Usage

board_register(board, name = board, cache = "~/.pins", ...)

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 "~/.pins".

...

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 "~/.pins" location. 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.

See Also

board_register_local, board_register_github, board_register_kaggle, board_register_rsconnect and board_register_datatxt.

Examples

# NOT RUN {
# 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())

# }