Skip to contents

Download files from AWS S3

Source: R/aws.R
sbfx_save_aws_files.Rd

Download files from an AWS S3 bucket into the analysis.

Usage

sbfx_save_aws_files(
  bucket_name,
  sub = subfoldr2::sbf_get_sub(),
  main = subfoldr2::sbf_get_main(),
  data_type = NULL,
  year = NULL,
  month = NULL,
  day = NULL,
  file_name = NULL,
  file_extension = NULL,
  max_request_size = 1000,
  ask = getOption("sbf.ask", TRUE),
  silent = TRUE,
  aws_access_key_id = Sys.getenv("AWS_ACCESS_KEY_ID"),
  aws_secret_access_key = Sys.getenv("AWS_SECRET_ACCESS_KEY"),
  region = Sys.getenv("AWS_REGION", "ca-central-1")
)

Arguments

bucket_name

A string of the AWS S3 bucket name.

sub

A string specifying the path to the sub folder (by default the current sub folder).

main

A string specifying the path to the main folder (by default the current main folder)

data_type

A string (by default NULL) for which data type to return. Check the folder names within the shiny-upload in AWS for options. Examples include punch-data, tracks, logger, image and pdf.

year

A whole number (by default NULL) indicating which year to return. Format YYYY.

month

A whole number (by default NULL) indicating which month to return. Format MM.

day

A whole number (by default NULL) indicating which day to return. Format DD.

file_name

A string (by default NULL) containing the name of the file to return. Do not include extension type.

file_extension

A string (by default NULL) with the file extension to return. Do not include period.

max_request_size

A whole number (by default 1000) indicating the maximum number of files to be returned.

ask

A flag specifying whether to ask before overwriting files.

silent

A flag (by default FALSE) to silence messages about number of files returned. Set to TRUE to silence messages.

aws_access_key_id

A string of your AWS user access key ID. The default is the environment variable named AWS_ACCESS_KEY_ID.

aws_secret_access_key

A string of your AWS user secret access key. The default is the environment variable named AWS_SECRET_ACCESS_KEY.

region

A string of the AWS region. The default is the environment variable named AWS_REGION.

See also

Other save functions: sbfx_save_data_to_pg()

Examples

if (FALSE) { # \dontrun{
sbfx_save_aws_files(
  bucket_name = "exploit-upload-poissonconsulting",
  data_type = "upload-recapture",
  year = 2021,
  file_name = "processed_data",
  file_extension = "csv"
)
} # }