R/repo_setup.R

In gopalpenny/ggp: General functions for coding assistance

# repo_setup.R

#' Project repo setup guide
#'
#' See examples to set up a new project repository:
#' @export
#' @examples
#' \dontrun{
#' # In terminal:
#' cd path/to/superdirectory
#' mkdir repo_name
#' cd repo_name
#'
#' # In R
#' setwd("path/to/new/repo")
#' repo_init()
#' repo_create_gdrive_symlink(fig_path=NULL,gdrive_path="path/to/gdrive/project/directory")
#' }
repo_setup_guide <- function() {
  return(NULL)
}

#' Create a repository with GP standard structure
#'
#' Create a project repository with GP standard structure. Should be done INSIDE
#' the dirctory that will house the repository.
#' @export
#' @examples
#' \dontrun{
#' setwd("path/to/repo")
#' repo_init()
#' }
repo_init <- function(path) {
  repo_structure <- c("data",
                      "data/orig",
                      "data/format",
                      "results",
                      "results/fig",
                      "results/output",
                      "src",
                      "src/report",
                      "src/plot",
                      "src/prep",
                      "src/proc",
                      "spatial",
                      "spatial/qgs",
                      "spatial/raster",
                      "spatial/shp",
                      "spatial/unmod")
  for (i in 1:length(repo_structure)) {
    dir.create(repo_structure[i])
  }
  cat("Other things to do:\n",
      "Create symlink to gdrive using repo_create_gdrive_symlink()")
}

#' Create symbolic link to gdrive
#'
#' Create symbolic link to gdrive
#' @export
#' @examples
#' \dontrun{
#' repo_create_gdrive_symlink(gdrive_path="~/Google Drive/my_project/fig")
#' }
repo_create_gdrive_symlink <- function(link_path=NULL,gdrive_path) {
  if (is.null(link_path)) {
    a <- Sys.info()
    fig_path <- repo_find_fig_path()
    symlink_name <- paste0("gdrive",gsub("\\.local","",a['nodename']))
    symlink_path <- file.path(fig_path,symlink_name)
  } else {
    symlink_path <- link_path
  }
  R.utils::createLink(symlink_path,gdrive_path)
  cat(symlink_path,"->",gdrive_path,"|| symlink created.\n")
  return(NULL)
}

#' Find fig path in repo
repo_find_fig_path <- function() {
  search_dirs_1 <- c("./results/figure","../results/figure","../../results/figure","../../../results/figure")
  search_dirs_2 <- gsub("figure","fig",search_dirs_1)
  search_dirs_3 <- gsub("results","res",search_dirs_1)
  search_dirs <- c(search_dirs_1,search_dirs_2,search_dirs_3)
  fig_path <- search_dirs[dir.exists(search_dirs)][1]
  if (is.na(fig_path)) {
    cat("Could not find figure path. Looked in:\n",search_dirs)
    stop("exiting get_gdrive_fig_path.")
  }
  return(fig_path)
}

#' Load local repository
#'
#' Load local package using \code{devtools::load_all()}. The repository should
#' be located in ~/Projects/R_packages or in the
#' @param repo_name Name of the package repository
#' @param project_path Path to the directory in which the repo is contained. Also searches
#' in the subdirectory \code{project_path/R_packages}.
repo_load_local <- function(repo_name,project_path="~/Projects") {
  projects_files <- list.files(project_path)
  packages_path <- projects_files
  search_dirs_1 <- file.path(c("~/Projects/R_packages",project_path),repo_name)
  search_dirs <- c(search_dirs_1)
  repo_path <- search_dirs[dir.exists(search_dirs)][1]
  if (is.na(repo_path)) {
    cat("Could not find repo path. Looked in:\n",search_dirs)
    stop("exiting get_gdrive_fig_path.")
  }

  devtools::load_all(repo_path)

  return(NULL)
}