upgo_aws_download: Function to download file from the UPGo AWS bucket

Description Usage Arguments Details Value

View source: R/upgo_aws_download.R

Description

upgo_aws_download downloads a specified file from the UPGo AWS bucket

Usage

1
upgo_aws_download(object_name, file_path = NULL, quiet = FALSE)

Arguments

object_name

A character string which identifies the file name to be downloaded.

file_path

A character string which optionally identifies a subfolder of the working directory in which to save the output.

quiet

A logical scalar. Should the function execute quietly, or should it return status updates throughout the function (default)?

Details

This is a convenience wrapper around aws.s3::save_object to download a single object from the UPGo AWS bucket. It will only work with appropriate values for 'AWS_ACCESS_KEY_ID' and 'AWS_SECRET_ACCESS_KEY' saved in .Renviron.

Value

The output will be a file saved to disk in the current working directory (possibly modified by the 'file_path' argument).


UPGo-McGill/upgo documentation built on Nov. 20, 2021, 2:26 a.m.