R/read_organisation.R

In inbo/checklist: A Thorough and Strict Set of Checks for R Packages and Source Code

#' Read the organisation file
#'
#' The checklist package stores organisation information in the
#' `organisation.yml` file in the root of a project.
#' @inheritParams read_checklist
#' @return An `organisation` object.
#' @export
#' @importFrom assertthat assert_that has_name is.string
#' @importFrom fs is_dir is_file path path_real path_split
#' @importFrom yaml read_yaml
#' @family both
read_organisation <- function(x = ".") {
  checklist <- try(read_checklist(x = x), silent = TRUE)
  if (inherits(checklist, "checklist")) {
    x <- checklist$get_path
  }
  organisation_file <- path(x, "organisation.yml")
  if (is_file(organisation_file)) {
    read_yaml(organisation_file) |>
      do.call(what = organisation$new) -> org
    return(org)
  }
  R_user_dir("checklist", which = "config") |>
    path("organisation.yml") -> organisation_default
  if (is_file(organisation_default)) {
    read_yaml(organisation_default) |>
      do.call(what = organisation$new) -> org
    write_organisation(org = org, x = x)
    return(org)
  }
  return(organisation$new())
}