get_remote_directory: Create a Path to the People Survey Shared-Drive Area

View source: R/connections.R

get_remote_directoryR Documentation

Create a Path to the People Survey Shared-Drive Area

Description

#' @description Get the remote directory on the network drive that contains the People Survey data.

Usage

get_remote_directory(dir = NULL)

Arguments

dir

Character. A pre-supplied path to the remote directory. Defaults to 'NULL'.

Details

If a macOS user is connected to the network drive and the path exists the function returns without user action. On Windows or on a Mac with a different mount point, the user will be presented with an RStudio GUI dialog to select the directory. This must be the "People Survey" folder, not anywhere deeper in the file tree. Assumes the user is using the RStudio IDE.

Value

A charcter string.

Examples

## Not run: get_remote_directory()

co-analysis/cspstools documentation built on Sept. 20, 2022, 1:10 a.m.