R/calculate_scores_check.r

In OHI-Science/ohirepos: Create OHI tailored repositories

## calculate_scores_check

#' Calculate scores for OHI repository
#'
#' @param repo_registry data frame with information about the repo 
#' @param ohicore_version string with version written as 'ohicore' (default) or 'ohicore@branch_name'
#' @param push T/F: do you want to add, commit, and push? Defaults to FALSE.
#'
#' @return TBD
#' @export
#'
#' @examples
#' \dontrun{# TBD}
calculate_scores_check <- function(repo_registry, 
                                   ohicore_version = 'ohicore', 
                                   push = FALSE){

  ## create variables
  dir_repo     <- repo_registry$dir_repo
  dir_scenario <- file.path(dir_repo, repo_registry$scenario_name)
  dir_temp     <- file.path(dir_scenario, 'temp')
  wd           <- getwd()
  
  ## create a temp folder for reference point stuff
  if(!file.exists(dir_temp)) dir.create(dir_temp)
  
  ## load ohicore
  devtools::install_github(sprintf('ohi-science/%s', ohicore_version))
  library(ohicore)

  ## ensure on master branch
  #git2r::checkout(repo, 'master')

  # iterate through all scenarios (by finding layers.csv)
  dirs_scenario <- normalizePath(dirname(
    list.files(dir_scenario, '^layers.csv$', recursive=TRUE, full.names=TRUE)))
  
  for (dir_scen in dirs_scenario){ # dir_scen=dirs_scenario[1]

    # set working directory to scenario
    setwd(dir_scen)
    cat('\n\nCALCULATE SCORES for SCENARIO', basename(dir_scen), '\n')

    # load scenario configuration
    conf <<- ohicore::Conf('conf')

    # run checks on scenario layers
    ohicore::CheckLayers('layers.csv', 'layers', flds_id=conf$config$layers_id_fields)

    # load scenario layers
    layers <<- ohicore::Layers('layers.csv', 'layers')

    # calculate scenario scores
    scores <- ohicore::CalculateAll(conf, layers)
    readr::write_csv(scores, 'scores.csv', na='')

    # document versions of packages and specifics of ohicore
    cat(
      capture.output(sessionInfo()), '\n\n',
      readLines(file.path(system.file(package='ohicore'), 'DESCRIPTION')),
      file='session.txt', sep='\n')
  }

  if (push) {
    
    ## commit and push
    ohirepos::commit_and_push(
      key, 
      dir_repo,
      commit_message = sprintf("push calculated scores, etc", key), 
      branch = 'gh-pages')
    
  }
  
  ## reset working directory
  setwd(wd)
  
}