clean.software: Clean TAF Software

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

Clean TAF Software

Description

Selectively remove software from the local TAF software folder if not listed in ⁠SOFTWARE.bib⁠.

Usage

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

Arguments

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

Value

No return value, called for side effects.

Note

For each file (and subdirectory) in the software folder, the cleaning procedure selects between three cases:

1. File and version matches ⁠SOFTWARE.bib⁠ - do nothing.

2. Filename does not contain the version listed in ⁠SOFTWARE.bib⁠ - remove.

3. File is not listed in ⁠SOFTWARE.bib⁠ - remove.

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

See Also

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

download.github downloads a GitHub repository.

clean.library cleans the local TAF library.

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

TAF-package gives an overview of the package.

Examples

## Not run: 
clean.software()

## End(Not run)

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