R/paths.R

In orderly: Lightweight Reproducible Reporting

path_data <- function(root) {
  file.path(root, "data")
}
path_rds <- function(root) {
  file.path(path_data(root), "rds")
}
path_csv <- function(root) {
  file.path(path_data(root), "csv")
}
path_draft <- function(root) {
  file.path(root, "draft")
}
path_src <- function(root) {
  file.path(root, "src")
}
path_archive <- function(root, name = NULL) {
  if (is.null(name)) {
    file.path(root, "archive")
  } else {
    file.path(root, "archive", name)
  }
}

path_metadata <- function(root) {
  file.path(root, "metadata")
}

path_remote_cache <- function(root) {
  file.path(root, ".orderly", "remote", "cache")
}


path_archive_broken <- function() {
  "archive_broken"
}


path_orderly_config_yml <- function(root) {
  file.path(root, "orderly_config.yml")
}

path_orderly_run_rds <- function(path) {
  file.path(path, "orderly_run.rds")
}

path_orderly_fail_rds <- function(path) {
  file.path(path, "orderly_fail.rds")
}

path_orderly_envir_yml <- function(path) {
  file.path(path, "orderly_envir.yml")
}

path_orderly_log <- function(path) {
  file.path(path, "orderly.log")
}


## Used in migrations
path_orderly_run_rds_backup <- function(path, version) {
  file.path(path, sprintf("orderly_run_%s.rds", version))
}


path_orderly_archive_version <- function(path) {
  file.path(path, "archive", ".orderly_archive_version")
}


path_changelog_txt <- function(path, type) {
  file.path(path, "changelog.txt")
}


path_db_backup <- function(root, file, suffix = NULL) {
  if (is.null(suffix)) {
    filename <- basename(file)
  } else {
    filename <- paste0(basename(file), suffix)
  }
  file.path(root, "backup", "db", filename, fsep = "/")
}


path_demo_yml <- function(root) {
  file.path(root, "demo.yml")
}