legacy_gcloud: Google Cloud board (legacy API)

Description Usage Arguments Examples

View source: R/legacy_gcloud.R

Description

To use a Google Cloud Storage board, you first need a Google Cloud Storage account, a Google Storage bucket, and an access token or the Google Cloud SDK properly installed and configured. You can sign-up and create these from https://console.cloud.google.com

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
legacy_gcloud(
  bucket = Sys.getenv("GCLOUD_STORAGE_BUCKET"),
  token = NULL,
  cache = NULL,
  name = "gcloud",
  ...
)

board_register_gcloud(
  name = "gcloud",
  bucket = Sys.getenv("GCLOUD_STORAGE_BUCKET"),
  token = NULL,
  cache = board_cache_path(name),
  path = NULL,
  ...
)

Arguments

bucket

The name of the Google Cloud Storage bucket. Defaults to the GCLOUD_STORAGE_BUCKET environment variable.

token

The access token of the Google Cloud Storage container. Generally, it's best to leave this as NULL, and rely on the installed Google Cloud SDK to handle authentication.

If you do want to use an access token, you can retrieve it from https://developers.google.com/oauthplayground. You will need to authorize the "Google Storage API v1" scope.

cache

Cache path. Every board requires a local cache to avoid downloading files multiple times. The default stores in a standard cache location for your operating system, but you can override if needed.

name

An optional name used identify the board. This is no longer generally needed since you should be passing around an explicit board object.

...

Additional parameters required to initialize a particular board.

path

Subdirectory within url

Examples

1
2
3
4
5
## Not run: 
# the following example requires the Google Cloud SDK to be configured
board <- legacy_gcloud(container = "gcloudcontainer")

## End(Not run)

pins documentation built on Oct. 2, 2021, 5:06 p.m.