R/default_params_doc.R

In Giappo/jappe: Jap

#' This function does nothing. It is intended to inherit is parameters'
#' documentation.
#' @param account a peregrine account
#' @param age the age of the phylogeny
#' @param cluster_folder main folder on the cluster. It can be either 'home'
#'  or 'data'
#' @param cluster_partition A string, with name of partition in which to run
#'  the main job. Defaults to \code{"gelifes"}, accepts \code{"regular"},
#'  \code{"short"} and remaining Peregrine partitions.
#' @param delete_on_cluster do you want to delete the files from the cluster
#'  after the download?
#' @param dir a directory
#' @param drive do you want to use google drive to store the data of your
#'  prokects? It can be either TRUE or FALSE
#' @param file a file
#' @param function_name the name of the function
#' @param fun_arguments the arguments of the function passed either as
#'  list or as string (in the format 'arg1 = x, arg2 = y')
#' @param github_name the github account name where the repo is
#' @param github_repo a github repository
#' @param github_folder_name name of the local folder containing all the
#'  github repos
#' @param home_dir path to the home directory. On windows usually is
#'  a disk like C or D. On mac is always ~.
#' @param lambda speciation rate
#' @param mu extinction rate
#' @param message a message to be print
#' @param package_name the name of the package
#' @param path a path
#' @param projects_folder_name the name you want to give to the folder
#'  containing all your projects
#' @param project_name the name of the project
#' @param session a ssh session
#' @param subfolder a subfolder of the project folder
#' @param t time
#' @param tree_file a tree file in format nexus or .tree
#' @param verbose choose if you want to print the output or not
#' @author Documentation by Giovanni Laudanno,
#' @note This is an internal function, so it should be marked with
#'   \code{@noRd}. This is not done, as this will disallow all
#'   functions to find the documentation parameters
default_params_doc <- function(
  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
) {
  # Nothing
}