R/default_params_doc.R

Defines functions default_params_doc

Documented in default_params_doc

#' Documentation of general function arguments.
#' This function does nothing.
#' It is intended to inherit function argument documentation.
#' @param trees_filename Name of a BEAST2 posterior \code{.trees} file.
#' @author Richèl J.C. Bilderbeek
#' @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(
  trees_filename
) {
  # Nothing
}
ropensci/tracerer documentation built on March 12, 2019, 8:30 p.m.