R/get-datafile.R

In nbc/didoscalim: Charger des données dans DiDo

#' Récupère un datafile
#'
#' Permet de récupérer les données d'un datafile en utilisant soit son rid soit
#' son titre.
#'
#' Lève une exception si la recherche ne retourne plus ou moins que 1 datafile
#'
#' @param data un rid de datafile, un objet `dido_job()` (ou un
#'   `dido_datafile()` même si l'intérêt est limité).
#' @param title le titre d'un datafile
#' @param dataset optionnel l'identifiant du dataset ou un objet
#'   `dido_dataset()`
#'
#' @return un objet [dido_datafile()]
#'
#' @family datafile
#'
#' @export
#'
#' @examples
#' \dontrun{
#' get_datafile("rid")
#' get_datafile(title = "title")
#' }
get_datafile <- function(data = NULL, title = NULL, dataset = NULL) {
  if (is.null(data) && is.null(title)) {
    msg <- glue::glue("Vous devez préciser un des deux arguments `rid` ou `title`")
    rlang::abort("error_bad_argument", message = msg)
  }

  if (!is.null(data) && !is.null(title)) {
    msg <- glue::glue("`datafile` et `title` sont données, la recherchera est faite par `datafile`")
    rlang::warn(message = msg)
  }

  dataset_id <- if (!is.null(dataset)) get_dataset_id(dataset) else NULL

  if (!is.null(title)) {
    df <- list_datafiles()
    result <- find_by_column(df, title, "title", c("id", "rid"))
    dataset_id <- result$id
    rid <- result$rid
  } else {
    rid <- get_datafile_rid(data)
    if (is.null(dataset_id)) dataset_id <- get_datafile_id_by_rid(rid)
  }

  url <- glue::glue("/datasets/{dataset_id}/datafiles/{rid}")
  result <- dido_api(method = "GET", path = url)

  attr(result, "id") <- dataset_id

  new_dido_datafile(result)
}

get_datafile_id_by_rid <- function(rid) {
  find_by_column(data = list_datafiles(), string = stringr::fixed(rid), col = "rid")
}