R/kgl_flow_meta.R

In KoderKow/kaggler: Kaggle API Client

#' Read the project's metadata
#'
#' Read the metadata of the competitions datasets.
#'
#' @return A data frame with one row per competition dataset.
#' @export
#' @family Kaggle Flow
#'
#' @examples
#' \dontrun{
#' kgl_flow("titanic")
#'
#' kgl_flow_meta()
#' }
kgl_flow_meta <- function() {
  dir_meta <- fs::path(.kgl_dir, "meta")
  path_meta <- fs::path(dir_meta, "meta")
  path_meta_id <- fs::path(dir_meta, "competition_id")

  if (fs::file_exists(path_meta) && fs::file_exists(path_meta_id)) {
    if (identical(parent.frame(n = 1), globalenv())) {
      usethis::ui_info("Competition ID: {usethis::ui_value(readLines(path_meta_id)[2])}")
    }

    readRDS(path_meta)
  } else {
    ui_kgl_flow <- usethis::ui_value("kgl_flow()")
    usethis::ui_todo("metadata files does not exist. Do you need to execute {ui_kgl_flow}?")
  }
}

#' Show competition info
#'
#' This function will show some competition information for the current project.
#'
#' @return Compeition info.
#' @export
#' @family Kaggle Flow
#'
#' @examples
#' \dontrun{
#' kgl_flow("titanic")
#'
#' kgl_flow_competition_info()
#' }
kgl_flow_competition_info <- function() {
  dir_meta <- fs::path(.kgl_dir, "meta")
  path_compeition_info <- fs::path(dir_meta, "competition_info")

  if (fs::file_exists(path_compeition_info)) {
    readRDS(path_compeition_info)
  } else {
    # ui_kgl_flow <- usethis::ui_value("kgl_flow()")
    # usethis::ui_todo("metadata files does not exist. Do you need to execute {ui_kgl_flow}?")
    usethis::ui_oops("File does not currently exist.")
  }
}