s3_get: Download a file from S3

In USGS-R/scipiper: Support functions for ushering data through a scientific workflow

Download a file from S3

Description

Download a file from S3 to the local project

Usage

s3_get(
  ind_file,
  verbose = FALSE,
  config_file = getOption("scipiper.s3_config_file"),
  ind_ext = getOption("scipiper.ind_ext"),
  use_local_aws_credentials = getOption("scipiper.use_local_aws_credentials")
)

Arguments

ind_file	character name of the indicator file for which data should be downloaded. downloads the S3 object whose key equals the data_file basename
verbose	logical used to determine whether to include messages specific to s3_get()
config_file	character name of the yml file containing project-specific configuration information
ind_ext	the indicator file extension to expect at the end of ind_file
use_local_aws_credentials	If TRUE (the default), then calls to this function will rely on credentials in ⁠~/.aws/credentials⁠; if FALSE, credentials will be gotten from EC2 metadata. Using credentials from EC2 metadata is appropriate when running on EC2 or ECS.

USGS-R/scipiper documentation built on May 25, 2023, 8:47 a.m.