pocket_experiment: Run an experiment on cluster

Description Usage Arguments Value Author(s)

View source: R/pocket_experiment.R

Description

Run an experiment on cluster

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
pocket_experiment(
  account = jap::your_account(),
  projects_folder_name = jap::default_projects_folder(),
  github_name = "Giappo",
  project_name = "sls",
  function_name = "sls_main",
  params,
  cluster_folder = jap::default_cluster_folder(),
  home_dir = jap::default_home_dir(),
  my_email = jap::default_my_email(),
  cluster_partition = "gelifes",
  jap_branch = "master",
  drive = jap::default_drive_choice(),
  delete_on_cluster = TRUE
)

Arguments

account

a peregrine account

projects_folder_name

the name you want to give to the folder containing all your projects

github_name

the github account name where the repo is

project_name

the name of the project

function_name

the name of the function

params

parameters for the function in the list format

cluster_folder

main folder on the cluster. It can be either 'home' or 'data'

home_dir

path to the home directory. On windows usually is a disk like C or D. On mac is always ~.

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.

drive

do you want to use google drive to store the data of your prokects? It can be either TRUE or FALSE

delete_on_cluster

do you want to delete the files from the cluster after the download?

Value

nothing

Author(s)

Giovanni Laudanno


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