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

In richelbilderbeek/lumier: Show How To Use Beautier

Description

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

Usage

default_params_doc(
  as_file,
  beautier_cmd,
  chain_length,
  clock_model,
  filename,
  gamma_site_model,
  input,
  input_filename,
  output,
  output_filename,
  store_every,
  subst_model,
  tree_prior,
  ui
)

Arguments

as_file	if TRUE, show create_beast_input_file, else show create_beast_input
beautier_cmd	the beautier command
chain_length	MCMC chain length
clock_model	the clock model, as text
filename	name of the file
gamma_site_model	a gamma_site_model, as created by create_gamma_site_model
input	the current user interface, as created by lum_create_ui
input_filename	the name of the FASTA filename
output	the new, changed user interface
output_filename	the name of the to-be-created BEAST2 file
store_every	MCMC store interval
subst_model	name of the substitution model
tree_prior	name of the tree prior
ui	the user interface, as created by lum_create_ui

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)

Richèl J.C. Bilderbeek

richelbilderbeek/lumier documentation built on March 13, 2021, 10:20 p.m.