taf.example: TAF Example

View source: R/taf.example.R

taf.exampleR Documentation

TAF Example

Description

Copy example analysis from TAF package.

Usage

taf.example(name, path = ".", force = FALSE)

Arguments

name

of TAF example analysis.

path

where to create example directory. The default is the current working directory.

force

whether to overwrite existing directory.

Details

Currently, the package comes with one example: "linreg".

Value

Full path to directory that was created.

Note

The example analysis is copied from the TAF package directory:

dir(system.file("examples", package="TAF"), full=TRUE)

See Also

taf.skeleton creates an empty TAF template.

linreg describes the linreg example.

TAF-package gives an overview of the package.

Examples

## Not run: 
taf.example("linreg")
setwd("linreg")
taf.boot()
source.all()

## End(Not run)


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