R/to_pff.R

Defines functions to_pff

Documented in to_pff

#' Convert a filename or folder to it Peregrine-friendly equivalent
#' @inheritParams default_params_doc
#' @examples
#' # Filenames
#' filename <- "/peregrine_unfriendly.csv"
#' pff <- to_pff(filename)
#'
#' filename <- "/tmp/peregrine_unfriendly.csv"
#' pff <- to_pff(filename)
#'
#' filename <- "/data/peregrine_unfriendly.csv"
#' pff <- to_pff(filename)
#'
#' # Folder names
#' foldername <- "/peregrine_unfriendly"
#' pff <- to_pff(foldername)
#'
#' foldername <- "/tmp/peregrine_unfriendly"
#' pff <- to_pff(foldername)
#'
#' foldername <- "/data/peregrine_unfriendly"
#' pff <- to_pff(foldername)
#' @export
to_pff <- function(filename) {
  file.path(
    peregrine::get_pff_tempdir(),
    basename(filename)
  )
}
richelbilderbeek/peregrine documentation built on Jan. 3, 2024, 7:42 p.m.