run_on_cluster: Run a function on cluster

In Giappo/jappe: Jap

Description

Run a function on cluster

Usage

run_on_cluster(
  github_name = NA,
  package_name,
  function_name,
  fun_arguments,
  run_name = "default",
  projects_folder_name = jap::default_projects_folder(),
  cluster_folder = jap::default_cluster_folder(),
  cluster_partition = "gelifes",
  home_dir = jap::default_home_dir(),
  account = jap::your_account(),
  my_email = jap::default_my_email(),
  drive = jap::default_drive_choice(),
  jap_branch = "master",
  session = NA
)

Arguments

github_name	the github account name where the repo is
package_name	the name of the package
function_name	the name of the function
fun_arguments	the arguments of the function passed either as list or as string (in the format 'arg1 = x, arg2 = y')
projects_folder_name	the name you want to give to the folder containing all your projects
cluster_folder	main folder on the cluster. It can be either 'home' or 'data'
cluster_partition	A string, with name of partition in which to run the main job. Defaults to "gelifes", accepts "regular", "short" and remaining Peregrine partitions.
home_dir	path to the home directory. On windows usually is a disk like C or D. On mac is always ~.
account	a peregrine account
drive	do you want to use google drive to store the data of your prokects? It can be either TRUE or FALSE
session	a ssh session

Value

nothing

Author(s)

Giovanni Laudanno

Giappo/jappe documentation built on Aug. 30, 2020, 2:41 p.m.