R/check_wd.R

In galacticpolymath/GPpub: Galactic Polymath Lesson Publishing Tools

#' Check if Working Directory Looks Good
#'
#' 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'.
#'
#' @param WD Working directory you want to check. default=getwd()
#' @param 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
#' @param throw_error logical; Do you want to stop code if error (T) or just throw a warning (F)? default=T
#' @returns depends on simple_out
#' @export
#'
check_wd<-function(WD="?",simple_out=TRUE,throw_error=TRUE){
   WD <- parse_wd(WD)

  if(basename(WD)=="galacticPubs"){
    message("galacticPubs environment: ignoring check_wd() call")
  }else{

  #Test that WD is a subfolder of 'Lessons'
  project<-basename(WD)
  parent<-path_parent_dir(WD) %>% basename()
  loc_check2<-parent=="Lessons"
  if(!loc_check2) {
    msg2 <-
      ("Not a subfolder of 'Lessons'. Make sure you're in the right WD (working directory).\n")
    if (throw_error) {
      stop(msg2)
    } else{
      warning(msg2)
    }
  }

  #Test if contains teaching-mat
  meta_files<-list.files(fs::path(WD,"meta"))
  teachmat_count<-stringr::str_detect(meta_files,"teach-it.*\\.gsheet") %>% sum

  loc_check3<-teachmat_count>0
  if(!loc_check3) {
    msg3 <-
      ("'meta/teach-it*.gsheet' not found.\n")
    if (throw_error) {
      stop(msg3)
    } else{
      warning(msg3)
    }
  }
  if(teachmat_count>1){
    stop("Duplicate 'teach-it' gsheets found. Like Highlander, there can only be one!")
  }

  test_result <- loc_check2&loc_check3
  if(simple_out){
  test_result
  }else{
    list(
    test_result=test_result,
    parent_folder_name=parent,
    project_folder_name=project,
    teaching_materials_found=loc_check3
    )
  }
}#end galacticPubs exception
}