R: GDP - Workflow Management

# GDP - Workflow Management

## Documentation for package ‘D4TAlink.light’ version 2.1.23

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

archiveTask | Create an archive containing the files of a given task.
binaryDir | Get path of binary directory.
binaryFn | Get path of binary file.
catReport | Output R object using function cat.
D4getenv | Get env var.
D4TAlink-common-args | Arguments used across the functions of the D4TAlink package.
D4TAlinkTask | 'D4TAlinkTask' Documentation of the D4TAlinkTask class
D4TAlink_common_args | Arguments used across the functions of the D4TAlink package.
datasourceDir | Get path of data source directory.
datasourceFn | Get path of data source file.
docDir | Get path of documentation directory.
docFn | Get path of documentation file.
DTx | Generic function.
formatTaskDocx | Replace default task fields in 'docx' file.
getTaskAuthor | Get the name of the task author.
getTaskEnckey | Get the encryption key for binary data files.
getTaskFilepath | Get the path of a file.
getTaskPaths | Get the paths of the task.
getTaskQmdTemplate | Get the path to the Quarto task template.
getTaskRmdTemplate | Get the path to the Rmd task template.
getTaskRoot | Get the root of the task repository.
getTaskRscriptTemplate | Get the path to the R script task template.
getTaskSponsor | Get the name of the task sponsor.
getTaskStructure | Get repository directory structure.
initTask | Initialize a task
initTaskQmd | Create task template in Quarto format.
initTaskRmd | Create task template in Rmd format.
initTaskRscript | Create task R script.
jpegReport | Graphics devices for 'JPEG' format bitmap files.
jpegReportFn | Get path of 'jpeg' output file.
listTaskFiles | List the files associated to a task.
listTasks | List details of all tasks stored in the root directory.
loadTask | Load a task.
pathsDefault | Task paths generator.
pathsGLPG | Task paths generator.
pathsPMS | Task paths generator.
pdfReport | Graphics devices for 'pdf' format bitmap files.
pdfReportFn | Get path of 'pdf' output file.
pngReport | Graphics devices for 'PNG' format bitmap files.
pngReportFn | Get path of 'png' output file.
progDir | Get path of scripts directory.
qmdFn | Get path of R script file name.
querySQLite | Load data frame by querying an SQLite database. This function executes a SQL query on an SQLite database file created with 'saveSQLite'.
readBinary | Restore R object from binary file.
readFeather | Restore R data.frame from Apache Arrow feather file.
readPickle | Restore R data.frame from a Python pickle file.
readReportJSON | Read JSON data into R object.
readReportTable | Read data into vector or list using function 'scan'.
readSQLite | Load data frame from SQLite. This function reads a data frame from an SQLite database file created with 'saveSQLite'.
renderTaskQmd | Render the task from the Qmd file
renderTaskRmd | Render the task from the Rmd file
reportDir | Get path of report directory.
reportFn | Get path of output file.
reportXlsFn | Get path of 'xlsx' output file.
restoreTask | Restore an archive containing the files of a given task from a file created with archiveTask.
rmdFn | Get path of R script file name.
rscriptFn | Get path of R script file name.
saveBinary | Save R object in binary file.
saveBinaryE | Save R object in encrypted binary file.
saveFeather | Save R object in Apache Arrow feather file.
savePickle | Save R object in Python pickle file.
saveReportJSON | Output R object in JSON format.
saveReportTable | Output R object using function 'write.csv'.
saveReportXls | Save R object in an Excel file. The function saves an R object in an Excel file, which can be either a data frame, an object of type 'AnnotatedDataFrame', or a list thereof. Cells containing formulas (starting with "=") are written as formulas in the Excel file.
saveSQLite | Save R data frame to SQLite file. This function saves a data frame to an SQLite database file. It can create indices on specified columns for faster querying. The database file is stored in the task's binary directory.
scanReport | Read data into vector or list using function 'scan'.
setTaskAuthor | Set the name of the tasks author.
setTaskEnckey | Set the encryption key for binary data files.
setTaskQmdTemplate | Set the path to the Quarto task template.
setTaskRmdTemplate | Set the path to the Rmd task template.
setTaskRoot | Set the root of the task repository.
setTaskRscriptTemplate | Set the path to the R script task template.
setTaskSponsor | Set the name of the tasks sponsor.
setTaskStructure | Set task repository directory structure.
taskID | Get task identifier string.