board_register_dospace: Register DigitalOcean Board

Description Usage Arguments Details See Also Examples

View source: R/board_registration.R

Description

Wrapper with explicit parameters over board_register() to register a DigitalOcean Spaces board.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
board_register_dospace(
  name = "dospace",
  space = Sys.getenv("DO_SPACE"),
  key = Sys.getenv("DO_ACCESS_KEY_ID"),
  secret = Sys.getenv("DO_SECRET_ACCESS_KEY"),
  datacenter = Sys.getenv("DO_DATACENTER"),
  cache = board_cache_path(),
  host = "digitaloceanspaces.com",
  path = NULL,
  ...
)

Arguments

name

Optional name for this board, defaults to 's3'.

space

The name of the DigitalOcean space. Defaults to the DO_SPACE environment variable.

key

The key of the DigitalOcean space. Defaults to the DO_ACCESS_KEY_ID environment variable.

secret

The secret of the DigitalOcean space. Defaults to the DO_SECRET_ACCESS_KEY environment variable.

datacenter

The datacenter of the DigitalOcean space. Defaults to the DO_DATACENTER environment variable.

cache

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

host

The host to use for storage, defaults to "digitaloceanspaces.com".

path

The subdirectory in the repo where the pins will be stored.

...

Additional parameters required to initialize a particular board.

Details

This function requires a DigitalOcean space to be manually created; otherwise, registering a DigitalOcean space will fail.

See Also

board_register

Examples

1
2
3
4
5
## Not run: 
# the following example requires a DigitalOcean Spaces API key
board_register_s3(bucket = "s3bucket")

## End(Not run)

pins documentation built on Jan. 8, 2021, 2:28 a.m.