Skip to content

Commit

Permalink
Update mcds_tools.R
Browse files Browse the repository at this point in the history
Minor update to documentation on how to stop using MCDS.exe
  • Loading branch information
lenthomas authored Feb 13, 2024
1 parent 74e64bd commit 689a9e9
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions R/mcds_tools.R
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,11 @@
#' on Mac M1 systems.
#'
#' @section Stopping using MCDS.exe:
#' Once this feature is enabled (see below) using `ddf` will always run both
#' its built-in R optimizer and `MCDS.exe`. To disable this behaviour remove
#' the `MCDS.exe` binary file. You can find it by running the following in R:
#' Once this feature is enabled, using `ddf` will by default run both
#' its built-in R optimizer and `MCDS.exe`. To disable this behaviour, specify which
#' you wish to use with via the \code{optimizer=} option described above. Alternatively,
#' if you wish to permanently stop using MCDS.exe, remove
#' the `MCDS.exe` binary file. You can find which folder it is in by running the following in R:
#' \code{system.file("MCDS.exe", package="mrds")}.
#'
#' @author David L Miller and Jonah McArthur
Expand Down

0 comments on commit 689a9e9

Please sign in to comment.