PopulationSimulationSet: PopulationSimulationSet

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

PopulationSimulationSet

Description

R6 class representing Reporting Engine Population Model Set

Super class

ospsuite.reportingengine::SimulationSet -> PopulationSimulationSet

Public fields

referencePopulation

logical for reference population used in Pediatric and Ratio Comparison workflows

populationFile

name of csv file to be used for the population

populationName

display name of population

studyDesignFile

name of study design csv file

plotReferenceObsData

logical for plotting reference observed data in Pediatric and Ratio Comparison workflows

Methods

Public methods

• PopulationSimulationSet$new()

• PopulationSimulationSet$copyInputFiles()

• PopulationSimulationSet$clone()

---

Method new()

Create a new 'PopulationSimulationSet' object.

Usage

PopulationSimulationSet$new(
  referencePopulation = FALSE,
  simulationSetName,
  simulationFile,
  populationFile,
  populationName = NULL,
  studyDesignFile = NULL,
  plotReferenceObsData = FALSE,
  ...
)

Arguments

referencePopulation

logical for reference population used in Pediatric and Ratio Comparison workflows

simulationSetName

display name of simulation set

simulationFile

names of pkml file to be used for the simulation

populationFile

name of csv file to be used for the population

populationName

display name of population

studyDesignFile

name of study design csv file

plotReferenceObsData

logical for plotting reference observed data in Pediatric and Ratio Comparison workflows

...

inputs inherited from 'SimulationSet'

Returns

A new 'PopulationSimulationSet' object

---

Method copyInputFiles()

Copy input files into a simulation set specific folder

Usage

PopulationSimulationSet$copyInputFiles(inputFilesFolder)

Arguments

inputFilesFolder

where input are located

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PopulationSimulationSet$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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