Add 'local.dir' examples

R/condor_dir.R

@@ -37,12 +37,17 @@
 #'
 #' @examples
 #' \dontrun{
+#'
+#' # General workflow
 #' session <- ssh_connect("servername")
 #'
 #' condor_submit()
 #' condor_q()
 #' condor_dir()
 #' condor_download()  # after job has finished
+#'
+#' # Alternatively, examine runs on local drive
+#' condor_dir(local.dir="c:/myruns")
 #' }
 #'
 #' @importFrom ssh ssh_exec_internal

R/condor_download.R

@@ -43,12 +43,17 @@
 #'
 #' @examples
 #' \dontrun{
+#'
+#' # General workflow
 #' session <- ssh_connect("servername")
 #'
 #' condor_submit()
 #' condor_q()
 #' condor_dir()
 #' condor_download()  # after job has finished
+#'
+#' # Alternatively, download specific run to specific folder
+#' condor_download("01_this_model", "c:/myruns/01_this_model")
 #' }
 #'
 #' @importFrom ssh scp_download ssh_exec_internal ssh_exec_wait

R/condor_log.R

@@ -30,11 +30,18 @@
 #'
 #' @examples
 #' \dontrun{
+#'
+#' # Examine log files on submitter machine
 #' session <- ssh_connect("servername")
 #'
 #' condor_dir()
 #' condor_log()
 #' summary(condor_log())
+#'
+#' # Alternatively, examine log file on local drive
+#' condor_dir(local.dir="c:/myruns")
+#' condor_log(local.dir="c:/myruns/01_this_model")
+#' summary(condor_log(local.dir="c:/myruns/01_this_model"))
 #' }
 #'
 #' @importFrom ssh ssh_exec_internal

R/condor_q.R

@@ -22,12 +22,17 @@
 #'
 #' @examples
 #' \dontrun{
+#'
+#' # General workflow
 #' session <- ssh_connect("servername")
 #'
 #' condor_submit()
 #' condor_q()
 #' condor_dir()
 #' condor_download()  # after job has finished
+#'
+#' # Alternatively, list number of jobs being run by each user
+#' condor_q(all=TRUE, count=TRUE)
 #' }
 #'
 #' @importFrom ssh ssh_exec_wait

R/condor_submit.R

@@ -42,12 +42,17 @@
 #'
 #' @examples
 #' \dontrun{
+#'
+#' # General workflow
 #' session <- ssh_connect("servername")
 #'
 #' condor_submit()
 #' condor_q()
 #' condor_dir()
 #' condor_download()  # after job has finished
+#'
+#' # Alternatively, submit a specific run
+#' condor_submit("c:/myruns/01_this_model")
 #' }
 #'
 #' @importFrom ssh scp_upload ssh_exec_internal ssh_exec_wait

R/summary.condor_log.R

@@ -22,11 +22,18 @@
 #'
 #' @examples
 #' \dontrun{
+#'
+#' # Examine log files on submitter machine
 #' session <- ssh_connect("servername")
 #'
 #' condor_dir()
 #' condor_log()
 #' summary(condor_log())
+#'
+#' #' # Alternatively, examine log files on local drive
+#' condor_dir(local.dir="c:/myruns")
+#' condor_log(local.dir="c:/myruns/01_this_model")
+#' summary(condor_log(local.dir="c:/myruns/01_this_model"))
 #' }
 #'
 #' @importFrom utils type.convert