Skip to content

Commit

Permalink
Documentation links to other packages' documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
richelbilderbeek committed Jun 24, 2024
1 parent 1632094 commit 2150931
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 14 deletions.
1 change: 1 addition & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Newest versions at top.

* Deprecate 'upgrade_babette', as this is against CRAN guidelines
* All functions have their return value documented
* Documentation links to other packages' documentation

### BUG FIXES

Expand Down
10 changes: 5 additions & 5 deletions R/default_params_doc.R
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@
#' @param mcmc the MCMC options,
#' see \link[beautier]{create_mcmc}
#' @param mrca_prior one Most Recent Common Ancestor prior,
#' as returned by \code{\link{create_mrca_prior}}
#' as returned by \code{\link[beautier]{create_mrca_prior}}
#' @param mrca_priors a list of one or more Most Recent Common Ancestor priors,
#' as returned by \code{\link{create_mrca_prior}}
#' as returned by \code{\link[beautier]{create_mrca_prior}}
#' @param overwrite will 'BEAST2' overwrite files? Like 'BEAST2',
#' this is set to \link{TRUE} by default.
#' If \link{TRUE}, 'BEAST2' will overwrite the
Expand All @@ -63,9 +63,9 @@
#' \code{beast2_options$output_state_filename} if its present
#' and \link{babette} will give an error message.
#' Note that if \code{overwrite} is set to \link{FALSE} when
#' a \code{tracelog} (see \link{create_tracelog}),
#' \code{screenlog} (see \link{create_screenlog})
#' or \code{treelog} (see \link{create_treelog})
#' a \code{tracelog} (see \link[beautier]{create_tracelog}),
#' \code{screenlog} (see \link[beautier]{create_screenlog})
#' or \code{treelog} (see \link[beautier]{create_treelog})
#' file already exists,
#' 'BEAST2' (and thus \link{babette}) will freeze.
#' @param rng_seed the random number generator seed. Must be either
Expand Down
8 changes: 4 additions & 4 deletions man/bbt_run.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions man/default_params_doc.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 2150931

Please sign in to comment.