initTask: Initialize a task

View source: R/initTask.R

initTaskR Documentation

Initialize a task

Description

During the initialization:

  • The folder structure for the task is created in the data repository.

  • The task properties are also saved in rds and json format.

Please note that it is recommended to load packages for your analysis before initializing the task.

Usage

initTask(
  project,
  package,
  taskname,
  sponsor = getTaskSponsor(),
  author = getTaskAuthor(),
  dirCreate = TRUE,
  templateCreate = FALSE,
  overwrite = FALSE
)

Arguments

project

Project name.

package

Package name.

taskname

Task name.

sponsor

Sponsor name, default set by setTaskSponsor.

author

Author name, system username by default.

dirCreate

logical, if TRUE (by default) the directory structure for the task is created in the repository.

templateCreate

create the prefilled Rmd template for the task, default value: FALSE.

overwrite

logical, if TRUE and the task already exists, overwrite its parameters.

Value

D4TAlinkTask object


D4TAlink.light documentation built on April 4, 2025, 1:02 a.m.