default_params_doc {tracerer} | R Documentation |
Documentation of general function arguments. This function does nothing. It is intended to inherit function argument documentation.
default_params_doc(
log_filename,
sample_interval,
state_filename,
trace,
tracelog_filename,
trees_filename,
trees_filenames,
verbose
)
log_filename |
deprecated name
of the BEAST2 tracelog |
sample_interval |
the interval in timesteps between samples |
state_filename |
name of the BEAST2 state |
trace |
the values |
tracelog_filename |
name of the BEAST2 tracelog |
trees_filename |
name of a BEAST2 posterior |
trees_filenames |
the names of one or more a BEAST2
posterior |
verbose |
set to TRUE for more output |
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
Richèl J.C. Bilderbeek