board_register_azure: Register Azure 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 Microsoft Azure Storage Blob as a board.

Usage

1
2
3
4
5
6
7
8
9
board_register_azure(
  name = "azure",
  container = Sys.getenv("AZURE_STORAGE_CONTAINER"),
  account = Sys.getenv("AZURE_STORAGE_ACCOUNT"),
  key = Sys.getenv("AZURE_STORAGE_KEY"),
  cache = board_cache_path(),
  path = NULL,
  ...
)

Arguments

name

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

container

The name of the Azure Storage container. Defaults to the AZURE_STORAGE_CONTAINER environment variable.

account

The account of the Azure Storage container. Defaults to the AZURE_STORAGE_ACCOUNT environment variable.

key

The key of the Azure Storage container Defaults to the AZURE_STORAGE_KEY environment variable.

cache

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

path

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

...

Additional parameters required to initialize a particular board.

Details

This function requires an Azure Storage container to be manually created; otherwise, registering an Azire board will fail.

See Also

board_register

Examples

1
2
3
4
5
6
7
## Not run: 
# the following example requires an Azure Storage key
board_register_azure(container = "pinscontainer",
                     account = "pinsstorage",
                     key = "abcabcabcabcabcabcabcabcabcab==")

## End(Not run)

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