cloud_s3_ls {cloudfs}

List Contents of Project's S3 Folder

Description

Returns a tibble with names, timestamps, and sizes of files and folders inside the specified S3 folder.

Usage

cloud_s3_ls(path = "", recursive = FALSE, full_names = FALSE, root = NULL)

Arguments

path

(optional) Path inside the S3 folder. Specifies the subfolder whose contents should be listed. By default, when path = "", lists root-level files and folders.

recursive

(logical) If TRUE, lists contents recursively in all nested subfolders. Default is FALSE.

full_names

(logical) If TRUE, folder path is appended to object names to give a relative file path.

root

S3 path of the project root. This serves as the reference point for all relative paths. When left as NULL, the root is automatically derived from the cloudfs.s3 field of the project's DESCRIPTION file.

Value

A tibble containing the names, last modification timestamps, and sizes in bytes of files and folders inside the specified S3 folder.

Examples

# list only root-level files and folders
cloud_s3_ls() 

# list all files in all nested folders
cloud_s3_ls(recursive = TRUE)

# list contents of "plots/barplots" subfolder
cloud_s3_ls("plots/barplots")