taf.install: TAF Install

Description Usage Arguments Details Value Note See Also Examples

View source: R/taf.install.R

Description

Install packages in ‘tar.gz’ format in local TAF library.

Usage

1
taf.install(targz = NULL, lib = "bootstrap/library", quiet = FALSE)

Arguments

targz

a package filename, vector of filenames, or NULL.

lib

location of local TAF library.

quiet

whether to suppress messages.

Details

If targz = NULL, all packages found in bootstrap/software are installed, as long as they have filenames of the form package_sha.tar.gz containing a 7-character SHA reference code.

The default behavior of taf.install is to install packages in alphabetical order. When the installation order matters because of dependencies, the user can specify a vector of package filenames to install.

Value

No return value, called for side effects.

Note

The taf.bootstrap procedure downloads and installs R packages, without requiring the user to run taf.install. The main reason for a TAF user to run taf.install directly is to initialize and run a TAF analysis without running the bootstrap procedure, e.g. to avoid updating the underlying datasets and software.

After installing the package, this function writes the remote SHA reference code into the package files DESCRIPTION and Meta/package.rds.

See Also

taf.bootstrap calls download.github and taf.install to download and install R packages.

taf.library loads a package from bootstrap/library.

clean.library selectively removes packages from the local TAF library.

install.packages is the underlying base function to install a package.

TAF-package gives an overview of the package.

Examples

1
2
3
4
5
6
7
8
## Not run: 
# Install one package
taf.install("bootstrap/software/FLAssess_f1e5acb.tar.gz")

# Install all packages found in bootstrap/software
taf.install()

## End(Not run)

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