clean: Clean TAF Directories

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

Clean TAF Directories

Description

Remove TAF directories: ⁠data⁠, ⁠model⁠, ⁠output⁠, and ⁠report⁠.

Usage

clean(dirs = c("data", model.dir(), "output", "report"), force = FALSE)

Arguments

dirs	directories to delete.
force	passed to clean.boot if any of the dirs is "boot".

Details

The ⁠model⁠ directory may also be named ⁠method⁠ and is cleaned in the same way.

Value

No return value, called for side effects.

Note

The purpose of removing the directories is to make sure that subsequent TAF scripts start by creating new empty directories.

If any of the dirs is "boot", it is treated specially and clean.boot is called to clean the ⁠boot⁠ directory.

In other words, clean("boot") and clean.boot() are interchangeable, the latter providing a slightly clearer interface that was introduced in version 4.2.0.

See Also

clean.boot cleans the boot directory.

mkdir and rmdir create and remove empty directories.

TAF-package gives an overview of the package.

Examples

## Not run: 
clean()
clean.boot()

## End(Not run)

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