D4TAlink-common-args {D4TAlink.light}R Documentation

Arguments used across the functions of the D4TAlink package.

Description

Arguments used across the functions of the D4TAlink package.

Arguments

project

Project name.

package

Package name.

taskname

Task name.

author

Author name, system username by default.

Sponsor name, default set by setTaskSponsor.

rootpath

Path of the task repository, default set by setTaskRoot.

task

Object of class D4TAlinkTask, as created by initTask.

type

Filename type. If the type is an array, the cocatenation of the elements is used with separator"-". Filenames have the form [task name]_[type].[ext]

ext

Filename extension.

suffix

Filename suffix, used to develop scripts for sub-analyses for a given task, default NA.

dirType

Directory type, e.g. 'bin' or 'data' or 'doc'.

subdir

(optional) Subdirectory.

dirCreate

Logical, if TRUE (by default) the directory is created.

pathgen

optional function returning a list of paths, currently pathsGLPG or pathsPMS.

Value

No return value, used for the documentation of the functions of the package.


[Package D4TAlink.light version 2.1.14 Index]