clean.library: Clean TAF Library

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

Clean TAF Library

Description

Selectively remove packages from the local TAF library if not listed in ⁠SOFTWARE.bib⁠.

Usage

clean.library(folder = "boot/library", quiet = FALSE, force = FALSE)

Arguments

folder	location of local TAF library.
quiet	whether to suppress messages about removed packages.
force	whether to remove the local TAF library, regardless of how it compares to ⁠SOFTWARE.bib⁠ entries.

Value

No return value, called for side effects.

Note

For each package, the cleaning procedure selects between three cases:

1. Installed package matches ⁠SOFTWARE.bib⁠ - do nothing.

2. Installed package is not the version listed in ⁠SOFTWARE.bib⁠ - remove.

3. Installed package is not listed in ⁠SOFTWARE.bib⁠ - remove.

The taf.boot procedure cleans the TAF library, without requiring the user to run clean.library. The main reason for a TAF user to run clean.library directly is to experiment with installing and removing different versions of software without modifying the ⁠SOFTWARE.bib⁠ file.

See Also

taf.boot calls clean.library as part of the default boot procedure.

taf.install installs a package in the local TAF library.

clean.software cleans the local TAF software folder.

clean.data cleans the ⁠boot/data⁠ folder.

TAF-package gives an overview of the package.

Examples

## Not run: 
clean.library()

## End(Not run)

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