R/tar_git_status_code.R

In ropensci/gittargets: Data Version Control for the Targets Package

#' @title Status of the code repository (Git)
#' @export
#' @family git
#' @description Show the Git status of the code repository.
#' @return If the code repository exists, the return value is the data frame
#'   produced by `gert::git_status(repo = code)`. If the code has no Git
#'   repository, then the return value is `NULL`.
#' @param code Character of length 1, directory path to the code repository,
#'   usually the root of the `targets` project.
#' @examples
#' if (Sys.getenv("TAR_EXAMPLES") == "true" && tar_git_ok(verbose = FALSE)) {
#' targets::tar_dir({ # Containing code does not modify the user's file space.
#' targets::tar_script(tar_target(data, 1))
#' targets::tar_make()
#' list.files("_targets", all.files = TRUE)
#' gert::git_init()
#' tar_git_init()
#' tar_git_status_code()
#' })
#' }
tar_git_status_code <- function(code = getwd()) {
  tar_assert_file(code)
  if_any(
    tar_git_repo_exists(repo = code),
    gert::git_status(repo = code),
    NULL
  )
}