default_params_doc: This function does nothing. It is intended to inherit is...

In Giappo/jappe: Jap

Description

This function does nothing. It is intended to inherit is parameters' documentation.

Usage

default_params_doc(
  account,
  age,
  cluster_folder,
  cluster_partition,
  delete_on_cluster,
  dir,
  drive,
  file,
  function_name,
  fun_arguments,
  github_name,
  github_repo,
  github_folder_name,
  home_dir,
  lambda,
  message,
  mu,
  package_name,
  path,
  projects_folder_name,
  project_name,
  session,
  subfolder,
  t,
  tree_file,
  verbose
)

Arguments

account	a peregrine account
age	the age of the phylogeny
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.
delete_on_cluster	do you want to delete the files from the cluster after the download?
dir	a directory
drive	do you want to use google drive to store the data of your prokects? It can be either TRUE or FALSE
file	a file
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')
github_name	the github account name where the repo is
github_repo	a github repository
github_folder_name	name of the local folder containing all the github repos
home_dir	path to the home directory. On windows usually is a disk like C or D. On mac is always ~.
lambda	speciation rate
message	a message to be print
mu	extinction rate
package_name	the name of the package
path	a path
projects_folder_name	the name you want to give to the folder containing all your projects
project_name	the name of the project
session	a ssh session
subfolder	a subfolder of the project folder
t	time
tree_file	a tree file in format nexus or .tree
verbose	choose if you want to print the output or not

Note

This is an internal function, so it should be marked with @noRd. This is not done, as this will disallow all functions to find the documentation parameters

Author(s)

Documentation by Giovanni Laudanno,

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