R/cheopsr.R

In bonartm/cheopsr: Talking to the Hight Performance CHEOPS Cluster at the University of Cologne

.onAttach <- function(libname, pkgname) {
  if (Sys.info()["sysname"] != "Linux")
    packageStartupMessage("The cheopsr package only works with a linux system.")

}

.onLoad <- function(libname, pkgname) {
  op <- options()
  op.cheopsr <- list(
    cheopsr.key = "~/.ssh/id_rsa",
    cheopsr.username = "bonartm",
    cheopsr.libloc = "./R/3.3.3_intel_mkl",
    cheopsr.module = "R/3.3.3_intel_mkl",
    cheopsr.account = "UniKoeln"
  )
  toset <- !(names(op.cheopsr) %in% names(op))
  if(any(toset)) options(op.cheopsr[toset])
  invisible()
}


#' Talk to the HPC cluster at the University of Cologne.
#'
#' @section Package options:
#' cheops r uses the folowing {\link[base]{options}} to set and read user parameters:
#' \itemize{
#' \item \code{cheopsr.key = "~/.ssh/id_rsa"}: ssh key location to log into the CHEOPS cluster. This option must be set!
#' \item \code{cheopsr.username = "user"}: user name to log into the CHEOPS cluster. This option must be set!
#' \item \code{cheopsr.libloc = "./R/3.3.3_intel_mkl"}: location of the personal R library on the cluster
#' \item \code{cheopsr.module = "R/3.3.3_intel_mkl"}: default R module which should be used when submitting jobs
#' \item \code{cheopsr.account = "UniKoeln"}: account which should be charged when submitting jobs
#' }
#'
#' @docType package
#' @name cheopsr
NULL