taf.skeleton: TAF Skeleton

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

TAF Skeleton

Description

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

Usage

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

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 the TAF package, i.e. library(TAF).
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

Value

Full path to analysis directory.

Note

After running taf.skeleton() to create a new TAF workflow, the author can populate the boot/initial/data folder with initial data files and run draft.data(file=TRUE) to produce a DATA.bib file.

The next step is then to run taf.boot() to populate the boot/data folder and start editing the data.R script, reading files from the boot/data folder.

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

## Not run: 
taf.skeleton()

## End(Not run)

ices-tools-prod/TAF documentation built on April 17, 2025, 2:02 p.m.