check.software: Check SOFTWARE.bib Against Global Packages

In ices-tools-prod/TAF: Transparent Assessment Framework for Reproducible Research

Check SOFTWARE.bib Against Global Packages

Description

Compare versions declared in ⁠SOFTWARE.bib⁠ with packages installed in the global R library.

Usage

check.software(full = FALSE)

Arguments

full	whether to return full data frame as output.

Value

Logical vector (or data frame if ⁠full = TRUE⁠) indicating which installed packages are ready, i.e., at least as new as the version required in ⁠SOFTWARE.bib⁠.

A warning is raised if any installed packages are older than required.

Note

Generally, TAF installs R packages that are declared in ⁠SOFTWARE.bib⁠ inside the TAF library (⁠boot/library⁠). This guarantees that the right versions of packages are installed for the analysis. The taf.library function is then used to load packages from the TAF library.

In special cases, however, it might be useful to compare the versions of packages declared in ⁠SOFTWARE.bib⁠ against packages that are installed in the global R library, outside the TAF library.

See Also

taf.boot and taf.library are the general tools to install and load packages of the correct version in the TAF library.

update.packages can be used to update packages in the general R library to the newest version available on CRAN.

Examples

## Not run: 
check.software()
check.software(full=TRUE)

## End(Not run)

ices-tools-prod/TAF documentation built on Nov. 15, 2024, 1:01 a.m.