get_s3_data: Fetch DAA S3 Data set

View source: R/get-s3-data.R

get_s3_dataR Documentation

Fetch DAA S3 Data set

Description

Fetches the indicated DAA data set from S3, applies appropriate naming, and returns as a dataframe. If no S3 Bucket is provided but a cache_folder is, then will attempt to retrieve a cache file. If no cache_folder is provided, then will not check for an existing cache and will not save a copy of the retrieved datset to a new or updated cache file.

Usage

get_s3_data(
  aws_s3_bucket = Sys.getenv("AWS_S3_BUCKET"),
  dataset_name = NULL,
  cache_folder = NULL
)

Arguments

aws_s3_bucket

The URL for the particular bucket being accessed.

dataset_name

The name of the dataset to be returned from S3.

Value

data A dataframe of the indicated data set.


pepfar-datim/daa-analytics documentation built on Nov. 24, 2024, 7:31 p.m.