inst/INSTALL.md

In HRTnomaly: Historical, Relational, and Tail Anomaly-Detection Algorithms

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 4.0.0.

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

• dplyr, for extending data manipolation in R;

• purrr, for extending functional programming in R;

• tidyr, for extending functionalities for several data-storage formats in R;

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

pkgnames <- c("dplyr", "purrr", "tidyr")
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)

Package management

Installing the stable release of the HRTnomaly package

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

install.packages("HRTnomaly")

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 HRTnomaly_25.2.25.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 HRTnomaly_25.2.25.tar.gz

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

Updating the HRTnomaly package

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

update.packages("HRTnomaly")

Removing the HRTnomaly package

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

remove.packages("HRTnomaly")

HRTnomaly documentation built on April 3, 2025, 6:17 p.m.