DataSource: DataSource
In Open-Systems-Pharmacology/OSPSuite.ReportingEngine: R package to create reports for the Open Systems Pharmacology models
DataSource R Documentation
DataSource
Description
R6 class managing observed data in simulation sets
Public fields
dataFilefile name of the observed dataset
metaDataFilefile name of the observed data dictionary
captiondisplayed legend of the data in the report
descriptordisplayed data source descriptor in the report
Methods
Public methods
Method new()
Create a new DataSource object.
Usage
DataSource$new(dataFile, metaDataFile, caption = NULL)
Arguments
dataFilefile name of the observed dataset
metaDataFilefile name of the observed data dictionary
captiondisplayed legend of the data in the report
Returns
A new DataSource object
Method getCaption()
Get the report caption that informs about the data source
Usage
DataSource$getCaption(workflowFolder = NULL)
Arguments
workflowFolderPath of workflow folder
Returns
A character string
Method getRelativeDataPath()
Get the relative data path compared to workflow folder
Usage
DataSource$getRelativeDataPath(workflowFolder)
Arguments
workflowFolderPath of workflow folder
Returns
A character string
Method clone()
The objects of this class are cloneable with this method.
Usage
DataSource$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Open-Systems-Pharmacology/OSPSuite.ReportingEngine documentation built on April 13, 2025, 10:37 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| DataSource | R Documentation |
DataSource
Description
R6 class managing observed data in simulation sets
Public fields
dataFilefile name of the observed dataset
metaDataFilefile name of the observed data dictionary
captiondisplayed legend of the data in the report
descriptordisplayed data source descriptor in the report
Methods
Public methods
Method new()
Create a new DataSource object.
Usage
DataSource$new(dataFile, metaDataFile, caption = NULL)
Arguments
dataFilefile name of the observed dataset
metaDataFilefile name of the observed data dictionary
captiondisplayed legend of the data in the report
Returns
A new DataSource object
Method getCaption()
Get the report caption that informs about the data source
Usage
DataSource$getCaption(workflowFolder = NULL)
Arguments
workflowFolderPath of workflow folder
Returns
A character string
Method getRelativeDataPath()
Get the relative data path compared to workflow folder
Usage
DataSource$getRelativeDataPath(workflowFolder)
Arguments
workflowFolderPath of workflow folder
Returns
A character string
Method clone()
The objects of this class are cloneable with this method.
Usage
DataSource$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.