R/is_pff.R

In richelbilderbeek/peregrine: Work With The Groninger Peregrine Computer Cluster

#' Is the filename a Peregrine-friendly filename?
#' @param filename name of the file
#' @seealso see \link{get_pff_tempdir} and \link{get_pff_tempfile}
#' to get a Peregrine-friendly temporary folder and filename
#' @examples
#' is_pff(get_pff_tempdir())
#' is_pff(get_pff_tempfile())
#' is_pff("/peregrine_unfriendly")
#' is_pff("/tmp/peregrine_unfriendly")
#' is_pff("/local/peregrine_unfriendly")
#' is_pff("/local/tmp/peregrine_unfriendly")
#' is_pff("/data/peregrine_unfriendly")
#' is_pff("/data/p230198/peregrine_unfriendly")
#' @seealso Use \link{to_pff} to convert a filename or folder to
#' its Peregrine-friendly equivalent
#' @author Richèl J.C. Bilderbeek
#' @export
is_pff <- function(filename) {
  testit::assert(length(filename) == 1)
  testit::assert(is.character(filename))
  testit::assert(nchar(filename) > 0)


  # Convert to canonical form
  filename <- gsub(pattern = "\\\\", replacement = "/", x = filename)

  if (stringr::str_count(string = filename, pattern = "/") == 1) {
    return(FALSE)
  }
  all(
    is.na(
      stringr::str_match(
        string = filename,
        pattern = "^(/tmp/|/data/|/local/)"
      )
    )
  )
}