inst/INSTALL.md

In dual: Automatic Differentiation with Dual Numbers

Installation requirements and instructions

Requirements

Most recent versions of the following software are always preferred, however the minimal requirements are also specified. The common software required by three main-stream operative systems are provided below, and any specific requirement is treated separately:

• R software: the minimal requirement is R version 3.5.1.

• R packages (it is recommended if the most recent versions of the following packages are installed):

  • Rcpp, for interfacing C++ code with R;
  • RcppArmadillo, for interfacing C++ algorithms for linear algebra with R;
  • devtools, for developing utilities and interfaces with on-line repositories;

To install the required packages, the following R code should be executed before the installation:

pkgnames <- c("Rcpp", "RcppArmadillo", "devtools")
pkgnames <- pkgnames[!pkgnames %in% .packages(TRUE)]
if (length(pkgnames)) install.packages(pkgnames)

To update all the installed packages to the last version available, the following command line should be typed into an R console:

update.packages(ask = FALSE)

The additional software must be installed before to update the required packages.

Additional software on Linux

• GNU compilers: the minimal requirement is gcc version 4.9.3.

Additional software on Windows

• Rtools is a library which provides the GNU compilers. The minimal requirement is Rtools33.exe, or other versions according to the R version already installed. Successively, the environmental variable PATH must be edited, because it must include the folders containing the GNU compilers provided.

Additional software on (Mac) OS X

• X-code is required to install the GNU compilers. The minimal requirement is gcc version 4.9.3, which allows for C++11 syntax.

Package management

Installing the stable release of the dual package

The use of the following R command is highly suggested to install the dual package:

install.packages("dual")

The other alternative to install an R package is from its source-code compressed as a tarball archive. This can be done by entering the following command into a terminal session on Linux and (Mac) OS X :

R CMD INSTALL dual_0.0.5.tar.gz

On Windows, by opening the command prompt (cmd.exe), it is possible to point to the proper directory with cd, and then install the package via Rcmd.exe with the following command:

Rcmd.exe INSTALL dual_0.0.5.tar.gz

More details can be found on the "Installing packages" section of the R-admin manual.

Installing the current development version of the package

devtools::install_github("drwolf85/dual")

Updating the dual package

To update the dual package, it is necessary to type the following code from the R console:

update.packages("dual")

Removing the dual package

To remove dual from the list of R packages, it is necessary to type the following code from the R console:

remove.packages("dual")

dual documentation built on Oct. 3, 2023, 9:07 a.m.