taf.bootstrap: Bootstrap TAF Analysis

Description Usage Arguments Details Value Note See Also Examples

View source: R/taf.bootstrap.R

Description

Process metadata files ‘SOFTWARE.bib’ and ‘DATA.bib’ to set up software and data files required for the analysis.

Usage

1
2
taf.bootstrap(software = TRUE, data = TRUE, clean = TRUE,
  force = FALSE, taf = NULL, quiet = FALSE)

Arguments

software

whether to process SOFTWARE.bib.

data

whether to process DATA.bib.

clean

whether to clean directories during the bootstrap procedure.

force

whether to remove existing bootstrap/data, bootstrap/library, and bootstrap/software directories before the bootstrap procedure.

taf

a convenience flag where taf = TRUE sets software, data, clean, and force to TRUE, as is done on the TAF server. Any other value of taf is ignored.

quiet

whether to suppress messages reporting progress.

Details

If clean = TRUE then:

  1. clean.software and clean.library are run if ‘SOFTWARE.bib’ is processed.

  2. clean.data is run if ‘DATA.bib’ is processed.

The default behavior of taf.bootstrap is to skip downloading of remote files (GitHub resources, URLs, bootstrap scripts) and also skip installing R packages from GitHub if the files seem to be already in place. This is done to speed up the bootstrap procedure as much as possible. To override this and guarantee that all data and software files are updated, pass force = TRUE to download and install everything declared in SOFTWARE.bib and DATA.bib.

Value

Logical vector indicating which metadata files were processed.

Note

This function should be called from the top directory of a TAF analysis. It looks for a directory called ‘bootstrap’ and prepares data files and software according to metadata specifications.

The bootstrap procedure consists of the following steps:

  1. If a bootstrap/SOFTWARE.bib metadata file exists, it is processed.

  2. If a bootstrap/DATA.bib metadata file exists, it is processed.

After the bootstrap procedure, software and data have been documented and are ready to be used in the subsequent analysis. Specifically, the procedure populates up to three new directories:

Model settings and configuration files can be set up within DATA.bib, see TAF Wiki.

See Also

draft.data and draft.software can be used to create initial draft versions of ‘DATA.bib’ and ‘SOFTWARE.bib’ metadata files.

taf.library loads a package from bootstrap/library.

TAF-package gives an overview of the package.

Examples

1
2
3
4
## Not run: 
taf.bootstrap()

## End(Not run)

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