check_wd: Check if Working Directory Looks Good

View source: R/check_wd.R

check_wdR Documentation

Check if Working Directory Looks Good

Description

The working directory gets reset sometimes for unknown reasons after running the editor. This is a routine check. Working directory should be a subfolder of 'Lessons'.

Usage

check_wd(WD = "?", simple_out = TRUE, throw_error = TRUE)

Arguments

WD

Working directory you want to check. default=getwd()

simple_out

logical; if TRUE results will be T/F (i.e. TRUE=looks good). If F, returns a list of test_result, parent_folder_name, and project_folder_name. default=T

throw_error

logical; Do you want to stop code if error (T) or just throw a warning (F)? default=T

Value

depends on simple_out


galacticpolymath/GPpub documentation built on April 5, 2025, 6:04 p.m.