TAF (version 4.3.0)

taf.skeleton: TAF Skeleton

Description

Create initial directories and R scripts for a new TAF analysis.

Usage

taf.skeleton(path = ".", force = FALSE, pkgs = taf.pkg(),
  model.script = "model.R", gitignore = TRUE)

Value

Full path to analysis directory.

Arguments

path

where to create initial directories and R scripts. The default is the current working directory.

force

whether to overwrite existing scripts.

pkgs

packages to load at the start of each script. The default is either "TAF" (if the icesTAF package is not attached) or "icesTAF" (if icesTAF is attached).

model.script

model script filename, either model.R (default) or method.R.

gitignore

whether to write TAF entries to a .gitignore file.

Details

When gitignore = TRUE, the following entries will be written to a .gitignore file, appending if the file exists already:

/boot/data
/boot/library
/boot/software
/data
/model
/output
/report
*.Rproj
.RData
.Rhistory
.Rproj.user
.Ruserdata

See Also

taf.example copies an example analysis from the TAF package.

package.skeleton creates an empty template for a new R package.

TAF-package gives an overview of the package.

Examples

if (FALSE) {
taf.skeleton()
}