clean.software: Clean TAF Software

Description Usage Arguments Value Note See Also Examples

View source: R/clean.software.R

Description

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

Usage

1
clean.software(folder = "bootstrap/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.bootstrap 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.bootstrap calls clean.software as part of the default bootstrap procedure.

download.github downloads a GitHub repository.

clean.library cleans the local TAF library.

clean.data cleans the bootstrap/data folder.

TAF-package gives an overview of the package.

Examples

1
2
3
4
## Not run: 
clean.software()

## End(Not run)

TAF documentation built on April 7, 2021, 5:06 p.m.