R/path_functions.R

In richelbilderbeek/razzo: The Error if Nature is MBD

#' Clean up a path by removing double folder seperators
#' @param filename name of a file
#' @author Richèl J.C. Bilderbeek
#' @examples
#' clean_path("a//b")
#' @export
clean_path <- function(filename) {
  assertive::assert_is_a_string(filename)
  mbd::file_path(filename)
}

#' Clean up a paths by removing double folder seperators
#' @param filenames names of files
#' @author Richèl J.C. Bilderbeek
#' @examples
#' clean_paths(c("a//b", "c//d"))
#' @export
clean_paths <- function(filenames) {
  assertive::assert_is_not_null(filenames)
  for (i in seq_along(filenames)) {
    assertive::assert_is_a_string(filenames[i])
    filenames[i] <- razzo::clean_path(filenames[i])
  }
  filenames
}

#' @title Get paths for the results
#' @description Get paths for the results
#' @inheritParams default_params_doc
#' @return the paths of the results
#' @author Giovanni Laudanno
#' @export
get_results_path <- function(
  project_folder_name
) {
  razzo::check_project_folder_name(project_folder_name) # nolint
  razzo::clean_path(
    file.path(
      project_folder_name,
      "results"
    )
  )
}

#' Get the folder paths of \code{razzo} experiments
#'
#' This function looks recursively for \code{parameters.RDa} files
#' and return the folder names of these.
#' @inheritParams default_params_doc
#' @param full_names TRUE if you want to return the full path
#' @return the folder paths of all \code{razzo} experiments
#' @examples
#' get_data_paths(raztr::get_raztr_path("razzo_project"))
#' @author Giovanni Laudanno, Richèl J.C. Bilderbeek
#' @export
get_data_paths <- function(
  project_folder_name,
  full_names = TRUE
) {
  razzo::check_project_folder_name(project_folder_name) # nolint
  razzo::clean_paths(
    dirname(
      list.files(
        path = project_folder_name,
        pattern = "parameters.RDa",
        recursive = TRUE,
        full.names = full_names
      )
    )
  )
}