R/s3path.r

Defines functions s3path

Documented in s3path

#' Get your default s3path or error.
#' @export
s3path <- function() {
  ## The default S3 prefix, for example, `s3://yourbucket/yourprefix/`.
  ## You should set this in everyone's `~/.Rprofile` if
  ## you are using s3mpi to collaborate in a data science team.
  ## System environment variables are also accepted.
  path <- get_option("s3mpi.path")

  if (is.null(path) || !nzchar(path)) {
    stop("s3mpi package: Please set your s3 path using `S3MPI_PATH` system environment variable or ",
         "options(s3mpi.path = 's3://your_bucket/your/path/'). ",
         "This is where all of your uploaded R objects will be stored.")
  }

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