s3.get: Fetch an R object from an S3 path.

Description Usage Arguments Value

Description

Fetch an R object from an S3 path.

Usage

1
2
3
4
5
6
7
s3.get(path, bucket_location = "US", verbose = FALSE, debug = FALSE,
  cache = TRUE, storage_format = c("RDS", "CSV", "table"), ...)

s3.put(x, path, name, bucket_location = "US", debug = FALSE,
  check_exists = TRUE, num_retries = get_option("s3mpi.num_retries", 0),
  backoff = 2^seq(2, num_retries + 1), max_backoff = 128,
  storage_format = c("RDS", "CSV", "table"), row.names = FALSE, ...)

Arguments

path

character. A full S3 path.

bucket_location

character. Usually "US".

verbose

logical. If TRUE, the s3cmd utility verbose flag will be set.

debug

logical. If TRUE, the s3cmd utility debug flag will be set.

cache

logical. If TRUE, an LRU in-memory cache will be referenced.

storage_format

character. What format the object is stored in. Defaults to RDS.

...

additional arguments to pass the the saving function.

x

ANY. R object to store to S3.

name

character.

check_exists

logical. Whether or not to check if an object already exists at the specificed location.

num_retries

numeric. the number of times to retry uploading.

backoff

numeric. Vector, with each element in seconds, describing the exponential backoff to be used in conjunction with the num_retries argument. Number of elements must equal num_retries. Defaults to 4, 8, 16, 32, etc.

max_backoff

numeric. Number describing the maximum seconds s3mpi will sleep prior to retrying an upload. Defaults to 128 seconds.

row.names

logical. Whether or not to write row names when writing CSV's or tables.

storage_format

character. What format to store files in. Defaults to RDS.

Value

For s3.get, the R object stored in RDS format on S3 in the path. For s3.put, the system exit code from running the s3cmd command line tool to perform the upload.


robertzk/s3mpi documentation built on May 27, 2019, 11:37 a.m.