Task: Task

In Open-Systems-Pharmacology/OSPSuite.ReportingEngine: R package to create reports for the Open Systems Pharmacology models

Task

Description

R6 class for Task settings

Public fields

active

logical indicating if 'Task' is performed in a workflow.

outputFolder

List of output files/folders to save the task output

workflowFolder

folder where workflow is run and saved

settings

list of settings for task such as plot configurations

message

message or title of the task

Methods

Public methods

• Task$new()

• Task$activate()

• Task$inactivate()

• Task$validateInput()

• Task$validateStructureSetInput()

• Task$print()

• Task$getRelativePath()

• Task$getAbsolutePath()

• Task$getInputs()

• Task$clone()

---

Method new()

Create a 'Task' object

Usage

Task$new(
  outputFolder = NULL,
  inputFolder = NULL,
  inputs = NULL,
  outputs = NULL,
  workflowFolder = getwd(),
  settings = NULL,
  active = FALSE,
  message = NULL
)

Arguments

outputFolder

task output folder to save results

inputFolder

task input folder where input files are stored

inputs

expected input files required by task

outputs

expected output files generated by task

workflowFolder

folder where workflow is run and saved

settings

specific settings for task (e.g. plot configurations)

active

logical indicating if 'Task' is performed in a workflow. Default value is 'FALSE'

message

message of the 'Task'.

Returns

A new 'Task' object

---

Method activate()

Activate 'Task'

Usage

Task$activate()

---

Method inactivate()

Inactivate 'Task'

Usage

Task$inactivate()

---

Method validateInput()

Check if 'Task' inputs exist

Usage

Task$validateInput()

Returns

logical indicating if input is valid

---

Method validateStructureSetInput()

Check if a task input from a specific 'SimulationStructure' is valid

Usage

Task$validateStructureSetInput(structureSet)

Arguments

structureSet

'SimulationStructure' object

Returns

logical indicating if input is valid

---

Method print()

Print 'Task' features

Usage

Task$print()

Returns

Text of task features

---

Method getRelativePath()

Get the relative path to a file to be output by this task

Usage

Task$getRelativePath(fileName)

Arguments

fileName

name (with extension) of the file to be output

Returns

Output file's relative path

---

Method getAbsolutePath()

Get the absolute path to a file to be output by this task

Usage

Task$getAbsolutePath(fileName)

Arguments

fileName

name (with extension) of the file to be output

Returns

Output file's absolute path

---

Method getInputs()

Get 'Task' required input files

Usage

Task$getInputs()

Returns

Required file names

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Task$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other workflow tasks: GofPlotTask, PlotTask, PopulationPlotTask, PopulationSensitivityAnalysisTask, QualificationTask, SensitivityAnalysisTask, addUserDefinedTask(), loadCalculatePKParametersTask(), loadCalculateSensitivityTask(), loadGOFMergedTask(), loadPlotAbsorptionTask(), loadPlotDDIRatioTask(), loadPlotDemographyTask(), loadPlotMassBalanceTask(), loadPlotPKParametersTask(), loadPlotPKRatioTask(), loadPlotSensitivityTask(), loadPlotTimeProfilesAndResidualsTask(), loadQualificationComparisonTimeProfileTask(), loadQualificationTimeProfilesTask(), loadSimulateTask()

Open-Systems-Pharmacology/OSPSuite.ReportingEngine documentation built on March 30, 2024, 4:17 p.m.