clean: Clean TAF Directories

Description Usage Arguments Value Note See Also Examples

View source: R/clean.R

Description

Remove working TAF directories (data, model, output, report), bootstrap, or other directories.

Usage

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

Arguments

dirs

directories to delete.

force

passed to software and clean.library if any of the dirs is "bootstrap".

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 "bootstrap" it is treated specially. Instead of completely removing the bootstrap directory, only the subdirectories data is removed, while clean.software and clean.library are used to clean the bootstrap/software and bootstrap/library subdirectories. This protects the subdirectory bootstrap/initial and *.bib metadata files from being accidentally deleted.

See Also

clean.software selectively removes software from bootstrap/software.

clean.library selectively removes packages from bootstrap/library.

clean.data selectively removes data from bootstrap/data.

mkdir and rmdir create and remove empty directories.

TAF-package gives an overview of the package.

Examples

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

## End(Not run)

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