get_gbci: Get a directory or file from the GBCI SharePoint

View source: R/utils.R

get_gbciR Documentation

Get a directory or file from the GBCI SharePoint

Description

This function will call either get_gbci_file or get_gbci_dir downstream depending on the path argument.

Usage

get_gbci(path, dest = NULL, overwrite = FALSE, create_dir = TRUE, drive = NULL)

get_gbci_file(
  path,
  dest = NULL,
  overwrite = FALSE,
  create_dir = TRUE,
  drive = NULL
)

get_gbci_dir(
  path,
  dest = NULL,
  overwrite = FALSE,
  create_dir = TRUE,
  drive = NULL
)

Arguments

path

Path to file or directory on SharePoint

dest

Where to put the file, and what to name it. Defaults to tempfile/dir

overwrite

Logical. Should files be overwritten if they aready exist?

create_dir

Logical. Should the destination directory be created if it doesn't exist?

drive

Optional. A Microsoft365R::ms_drive. Can be passed from parent functions to avoid multiple calls, which can be faster.

Value

The destination of the file or directory (dest)

Examples

## Not run: 
get_gbci_dir("Raw Data/SPECTRAmax/aragaki-kai/", "path/to/my/dir")

## End(Not run)

McConkeyLab/bladdr documentation built on April 6, 2024, 3:15 a.m.