R/set_mcbette_state.R

In richelbilderbeek/mcbetteinstall: Install 'babette'

#' Set the \link{mcbette} state.
#'
#' Set the \link{mcbette} state to having BEAST2 installed with
#' or without installing the BEAST2 NS package.
#'
#' @note In newer versions of BEAST2, BEAST2 comes pre-installed with the
#' BEAST2 NS package. For such a version, one cannot install BEAST2
#' without NS. A warning will be issues if one intends to only install
#' BEAST2 (i.e. without the BEAST2 NS package) and gets the BEAST2
#' NS package installed as a side effect as well.
#'
#' Also, installing or uninstalling a BEAST2 package from a BEAST2
#' installation will affect all installations.
#' @inheritParams default_params_doc
#' @seealso
#' \itemize{
#'   \item Use \link[mcbette]{get_mcbette_state} to
#'     get the current \link{mcbette} state
#'   \item Use \link[mcbette]{check_mcbette_state} to
#'     check the current \link{mcbette} state
#' }
#' @examples
#' mcbette_state <- mcbette::get_mcbette_state()
#' mcbette_state$beast2_installed <- TRUE
#' mcbette_state$ns_installed <- TRUE
#' \donttest{
#'   set_mcbette_state(mcbette_state)
#' }
#' @export
set_mcbette_state <- function(
  mcbette_state,
  beast2_folder = beastier::get_default_beast2_folder(),
  verbose = FALSE
) {
  mcbette::check_mcbette_state(mcbette_state)

  # Install BEAST2 if requested
  if (isTRUE(mcbette_state$beast2_installed) &&
    !beastier::is_beast2_installed(folder_name = beast2_folder)
  ) {
    beastierinstall::install_beast2(
      folder_name = beast2_folder,
      verbose = verbose
    )
  }

  # Install NS if requested
  if (isTRUE(mcbette_state$ns_installed) &&
      !mauricer::is_beast2_ns_pkg_installed(beast2_folder = beast2_folder)
  ) {
    mauricerinstall::install_beast2_pkg(
      "NS",
      beast2_folder = beast2_folder,
      verbose = verbose
    )
  }

  # Uninstall NS if requested
  # BEAST2 comes with the NS package pre-installed for newer version
  if (isFALSE(mcbette_state$ns_installed)
    && mauricer::is_beast2_ns_pkg_installed(beast2_folder = beast2_folder)
  ) {
    # Also uninstalls the global NS version :confused:
    # I guess the list of packages is a global :confused:
    mauricerinstall::uninstall_beast2_pkg(
      "NS",
      beast2_folder = beast2_folder,
      verbose = verbose
    )
  }

  # Uninstall BEAST2 if requested
  if (isFALSE(mcbette_state$beast2_installed) &&
    beastier::is_beast2_installed(folder_name = beast2_folder)
  ) {
    beastierinstall::uninstall_beast2(
      folder_name = beast2_folder,
      verbose = verbose
    )
  }

}