The DDMORE R Package


[Up] [Top]

Documentation for package ‘ddmore’ version 1.0.1

Help Pages

A B C D E F G H I L M N O P Q R S T U V W misc

-- A --

add_quotes add_quotes
as.data as.data
as.data.frame.DataSet Coerce DataSet object to data.frame
as.mdl as.mdl
as.mogObj as.mogObj
as.PharmML as.PharmML
as.xpdb as.xpdb
assignFun Assign column into Environment Assigns column x of a data frame into an environment

-- B --

bootstrap.PsN bootstrap.PsN Runs a PsN bootstrap of a given model.
buildSubmissionJob Build Submission Job
buildWorkflow Build Workflow

-- C --

cancelJob cancelJob
capitalise_first capitalise_first
checkDoseRows checkDoseRows
cleanUp -cleanup: function to remove NONMEM cruft. Based on Andy Hooker's cleanup.R function https://github.com/andrewhooker/MBAOD/blob/master/R/cleanup.R
createFISJob createFISJob
createFISJobFromNamedList createFISJobFromNamedList
createFISServer createFISServer
createFISServerFromProperties createFISServerFromProperties
createListTemplate Create List Template
createMogObj createMogObj

-- D --

dataObj-class Data Object S4 Class Definition.
DataSet The DataSet Object Class (S4)
DataSet-class The DataSet Object Class (S4)
DataSetDistribution The DataSetDistribution Object Class (S4)
DataSetDistribution-class The DataSetDistribution Object Class (S4)
DDMORE.cancelJob DDMORE.cancelJob
DDMORE.checkConfiguration DDMORE.checkConfiguration
DDMORE.clearUpStep DDMORE.clearUpStep
DDMORE.getJob DDMORE.getJob
DDMORE.getJobs DDMORE.getJobs
DDMORE.getServer DDMORE.getServer
DDMORE.importFilesStep DDMORE.importFilesStep
DDMORE.importSOStep DDMORE.importSOStep
DDMORE.performExecutionWorkflow DDMORE.performExecutionWorkflow
DDMORE.pollStep DDMORE.pollStep
DDMORE.prepareSubmissionStep DDMORE.prepareSubmissionStep
DDMORE.printJobs DDMORE.printJobs
DDMORE.safeStop DDMORE.safeStop
DDMORE.serverRunning DDMORE.serverRunning
DDMORE.setServer DDMORE.setServer
DDMORE.startServer DDMORE.startServer
DDMORE.stopServer DDMORE.stopServer
DDMORE.submitJob DDMORE.submitJob
DDMORE.submitJobStep DDMORE.submitJobStep
DDMORE.verifySOStep DDMORE.verifySOStep
designObj-class Design Object S4 Class Definition.
DiagnosticIndividualParams The DiagnosticIndividualParams Object Class (S4)
DiagnosticIndividualParams-class The DiagnosticIndividualParams Object Class (S4)
DiagnosticStructuralModel The DiagnosticStructuralModel Object Class (S4)
DiagnosticStructuralModel-class The DiagnosticStructuralModel Object Class (S4)

-- E --

estimate Estimate
estimate-method Estimate
Estimation The Estimation Object Class (S4)
Estimation-class The Estimation Object Class (S4)
execute INTERNAL Common execute function called by estimate() and the psnWrappers functions
execute-method INTERNAL Common execute function called by estimate() and the psnWrappers functions
extractIdandIdvNames Extract ID and IDV Names

-- F --

FISJob-class FIS Job S4 Class Definition.
fisJobToJSON Convert fisJob to JSON Converts FISJob objects to JSON representation.
FISServer-class FIS Server S4 Class Definition.

-- G --

getConvReportLogFile getConvReportLogFile
getDataObjects getDataObjects
getDataObjects-method getDataObjects
getDesignObjects getDesignObjects
getDesignObjects-method getDesignObjects
getEstimationInfo getEstimationInfo
getIndividualParameters getIndividualParameters
getJob getJob
getJobs getJobs
getMDLObjects getMDLObjects
getMLEPopulationParameters Extract MLE Population Parameters from SO Object
getModelObjects getModelObjects
getModelObjects-method getModelObjects
getParameterObjects getParameterObjects
getParameterObjects-method getParameterObjects
getPopulatedSlots Get Indication of Populated Slots
getPopulationParameters Get Population Parameters from SO Object This function acts on an object of class StandardOutputObject and is a wrapper to getMLEPopulationParameters(), getBayesianPopulationParameters() and getBootstrapPopulationParameters() presenting estimates of the STRUCTURAL and VARIABILITY parameters along with any associated measures of uncertainty (standard deviation) and interval estimates if these are available. The values available for return from the StandardOutputObject depend on the estimation method used and how these are populated - either directly from the estimation task output or subsequently via other methods e.g. bootstrapping. The function will provide suitable names for the columns depending on the methods used. So for example, although the argument for "what" accepts "precisions" this may mean SE assuming Normality, Bootstrap SE, SD from MCMC or SAEM estimation methods.
getPriorObjects getPriorObjects
getPriorObjects-method getPriorObjects
getStdErrFile getStdErrFile
getStdOutFile getStdOutFile
getTaskPropertiesObjects getTaskPropertiesObjects
getTaskPropertiesObjects-method getTaskPropertiesObjects

-- H --

health health
httpPost Performs HTTP Post request. It is a wrapper function for RCurl:::curlPerform This function stops only if the RCurl fails.

-- I --

importData Import Data from Data Object Imports the data file from a data object (class dataObj) and returns a data frame.
importJobResultFiles importJobResultFiles
IndividualEstimates The IndividualEstimates Object Class (S4)
IndividualEstimates-class The IndividualEstimates Object Class (S4)
IndividualEstimatesParamEstimates The IndividualEstimatesParamEstimates Object Class (S4)
IndividualEstimatesParamEstimates-class The IndividualEstimatesParamEstimates Object Class (S4)
IndividualEstimatesRandomEffects The IndividualEstimatesRandomEffects Object Class (S4)
IndividualEstimatesRandomEffects-class The IndividualEstimatesRandomEffects Object Class (S4)
initialize-method Initialisation function / Constructor for DataSet S4 class
initialize-method Initialisation function / Constructor for DataSetDistribution S4 class, subclass of DataSet S4 class.
initialize-method Initialisation function / Constructor for DiagnosticIndividualParams S4 class
initialize-method Initialisation function / Constructor for DiagnosticStructuralModel S4 class
initialize-method Initialisation function / Constructor for Estimation S4 class
initialize-method Initialisation function / Constructor for IndividualEstimates S4 class
initialize-method Initialisation function / Constructor for IndividualEstimatesParamEstimates S4 class
initialize-method Initialisation function / Constructor for IndividualEstimatesRandomEffects S4 class
initialize-method Initialisation function / Constructor for OFMeasures S4 class
initialize-method Initialisation function / Constructor for OptimalDesignBlock S4 class
initialize-method Initialisation function / Constructor for PopulationEstimates S4 class
initialize-method Initialisation function / Constructor for PopulationEstimatesBayesian S4 class
initialize-method Initialisation function / Constructor for PopulationEstimatesOtherMethod S4 class
initialize-method Initialisation function / Constructor for PrecisionIndividualEstimates S4 class
initialize-method Initialisation function / Constructor for PrecisionPopulationEstimates S4 class
initialize-method Initialisation function / Constructor for PrecisionPopulationEstimatesBayesian S4 class
initialize-method Initialisation function / Constructor for PrecisionPopulationEstimatesMLE S4 class
initialize-method Initialisation function / Constructor for PrecisionPopulationEstimatesOtherMethod S4 class
initialize-method Initialisation function / Constructor for RawResults S4 class
initialize-method Initialisation function / Constructor for Residuals S4 class
initialize-method Initialisation function / Constructor for SimulationBlock S4 class
initialize-method Initialisation function / Constructor for SimulationDataSet S4 class, subclass of DataSet S4 class.
initialize-method Initialisation function / Constructor for StandardOutputObject S4 class. Process an SOBlock element and its sub-tree of elements, from the SO XML tree, and populate a StandardOutputObject object from the data contained within.
initialize-method Initialisation function / Constructor for TaskInformation S4 class
is.dataObj is.dataObj
is.designObj is.designObj
is.empty Utility function to test whether a slot in the SO is empty or not.
is.FISJob is.FISJob
is.FISServer is.FISServer
is.mdlObj is.mdlObj
is.mogObj is.mogObj
is.parObj is.parObj
is.priorObj is.priorObj
is.SOObject is.SOObject
is.taskObj is.taskObj

-- L --

LoadSOObject LoadSOObject
LoadSOObjects LoadSOObjects

-- M --

mdlObj-class Model Object S4 Class Definition.
MDLToPharmML MDLToPharmML
mergeByPosition mergeByPosition
mergeCheckColumnNames mergeCheckColumnNames
message Override of the standard message() function.
ModelDiagnostic The ModelDiagnostic Object Class (S4)
ModelDiagnostic-class The ModelDiagnostic Object Class (S4)
mogObj-class MOG (Model Object Group) S4 Class Definition.

-- N --

ncasim.PsN ncasim.PsN Simulate a number of samples with a given model (internally using the PsN script nca)

-- O --

OFMeasures The OFMeasures Object Class (S4)
OFMeasures-class The OFMeasures Object Class (S4)
OptimalDesignBlock The OptimalDesignBlock Object Class (S4)
OptimalDesignBlock-class The OptimalDesignBlock Object Class (S4)

-- P --

parent.folder parent.folder
parObj-class Parameter Object S4 Class Definition.
parseDataSetDistribution parseDataSetDistribution
parseDataSetExternalFile parseDataSetExternalFile
parseDataSetInline parseDataSetInline
parseExternalFile parseExternalFile
parseMatrix parseMatrix
parseMDLFile Parse MDL File
parseSODataElement Parse SO Data Element
plot-method plot a dataObj object
plot-method plot a mogObj object
plot.dataObj plot a dataObj object
plot.mogObj plot a mogObj object
PopulationEstimates The PopulationEstimates Object Class (S4)
PopulationEstimates-class The PopulationEstimates Object Class (S4)
PopulationEstimatesBayesian The PopulationEstimatesBayesian Object Class (S4)
PopulationEstimatesBayesian-class The PopulationEstimatesBayesian Object Class (S4)
PopulationEstimatesOtherMethod The PopulationEstimatesOtherMethod Object Class (S4)
PopulationEstimatesOtherMethod-class The PopulationEstimatesOtherMethod Object Class (S4)
pprintDefTable Pretty print a Definition-Table element combination in the SO
PrecisionIndividualEstimates The PrecisionIndividualEstimates Object Class (S4)
PrecisionIndividualEstimates-class The PrecisionIndividualEstimates Object Class (S4)
PrecisionPopulationEstimates The PrecisionPopulationEstimates Object Class (S4)
PrecisionPopulationEstimates-class The PrecisionPopulationEstimates Object Class (S4)
PrecisionPopulationEstimatesBayesian The PrecisionPopulationEstimatesBayesian Object Class (S4)
PrecisionPopulationEstimatesBayesian-class The PrecisionPopulationEstimatesBayesian Object Class (S4)
PrecisionPopulationEstimatesMLE The PrecisionPopulationEstimatesMLE Object Class (S4)
PrecisionPopulationEstimatesMLE-class The PrecisionPopulationEstimatesMLE Object Class (S4)
PrecisionPopulationEstimatesOtherMethod The PrecisionPopulationEstimatesOtherMethod Object Class (S4)
PrecisionPopulationEstimatesOtherMethod-class The PrecisionPopulationEstimatesOtherMethod Object Class (S4)
prepareWinbugsDs prepareWinbugsDS This function implements the required preliminary steps before running a model in WinBugs. In particular, the data set is automatically transformed from a CSV NONMEM format into the WinBUGS format through the function NMTRAN2BUGSdataconverter Moreover, an additional file called pascal.properties is produced in order to provide the required information to the WinBUGS converter
priorObj-class Prior Object S4 Class Definition.

-- Q --

q Quit

-- R --

RawResults The RawResults Object Class (S4)
RawResults-class The RawResults Object Class (S4)
read-method updateParObj
read.NONMEMDataSet read.NONMEMDataSet
readDataObj readDataObj
readDataObj-method readDataObj
readMDL readMDL
Residuals The Residuals Object Class (S4)
Residuals-class The Residuals Object Class (S4)
resolveResultsDirectory Resolve Results Directory Resolves a directory where the results of the execution would be placed if the MDL file was executed.
row.merge.cbind Utility to merge extracted dataframe columns by rownames in the following functions
rowEvaluate Evaluate Code within a Data Frame and Update Evaluates a string containing R code on each row of a data frame and returns an updated data frame.
runPFIM Execute PFIM This function executes PFIM against specifiied MDL or PharmML encoded model file.
runWinBUGS runWinBUGS This function executes WinBUGS against specified MDL or PharmML encoded model file.

-- S --

sample sample from a dataObj
sample-method sample from a dataObj
setFinalSubmissionStatus Set Final Submission Status
shutdown shutdown
sim.PsN sim.PsN Simulate a number of samples with a given model (internally using the PsN script sse), keeping the standard table output format for a complete population of the SO.
simcyp.execute Perform a Simcyp execution
simcyp.generateMultiplePopulations Generate multiple Simcyp populations
simcyp.generateSinglePopulation Generate a Simcyp population
simcyp.getIDsFromOutput Extract IDs from the primary Simcyp Console output file
simcyp.getOutputIDs Get Simcyp output IDs
simcyp.getPopulationIDs Get Simcyp population IDs
simcyp.preprocess Perform Simcyp execution preprocessing
simcyp.simulate Run a Simcyp simulation using a workspace
simcyp.validateOutputID Validate an output ID
simcyp.validatePopulationID Validate a population ID
simcyp.validatePopulationSize Validate a population size
SimulationBlock The SimulationBlock Object Class (S4)
SimulationBlock-class The SimulationBlock Object Class (S4)
SimulationDataSet The SimulationDataSet Object Class (S4)
SimulationDataSet-class The SimulationDataSet Object Class (S4)
SSE.PsN SSE.PsN Performs SSE (Stochastic Simulation and Estimation) on a given model.
StandardOutputObject-class The Standard Output Object Class (S4)
startingValues startingValues
startingValues-method startingValues
strataSampler strataSampler
stratProb stratProb Function to rescale probabilities of being selected for a stratified sample. Rescale the probabilities within each strata. This is based on: prob(being chosen) = prob(being in strata) * prob(being selected from strata), we therefore scale by dividing by the probability of being in the strata (the number of rows in the strata divided by the number of rows in the data set)
strip_quotes strip_quotes
SUBMISSION_CANCELLED Cancelled Submission status string
SUBMISSION_COMPLETED Failed Submission status string
SUBMISSION_COMPLETED_WITH_ERRORS Submission status for a job that fails but due to domain-level result checks
SUBMISSION_FAILED Static Variables Failed Submission status string
SUBMISSION_STATUSES list holding the statuses recognized by the framework label - user-readable string final - flag indicating if the state is final or not.
submitJob submitJob
subset subset a dataObj
subset-method subset a dataObj

-- T --

TaskInformation The TaskInformation Object Class (S4)
TaskInformation-class The TaskInformation Object Class (S4)
taskObj-class Task Object S4 Class Definition.
ToFactor ToFactor
ToNumeric ToNumeric

-- U --

updateParObj updateParObj
updateParObj-method updateParObj
URLencode URLencode

-- V --

validateAndLoadXMLSOFile Check that the .SO.xml file exists; if so then parse the XML document and return a reference to the root node.
VPC.PsN VPC.PsN Performs a VPC (Visual Predictive Check) of a given model using PsN.

-- W --

writeMogObj writeMogObj
writeMogObj-method writeMogObj

-- misc --

.assignFun Assign column into Environment Assigns column x of a data frame into an environment
.buildSubmissionJob Build Submission Job
.buildWorkflow Build Workflow
.createListTemplate Create List Template
.fisJobToJSON Convert fisJob to JSON Converts FISJob objects to JSON representation.
.httpPost Performs HTTP Post request. It is a wrapper function for RCurl:::curlPerform This function stops only if the RCurl fails.
.importData Import Data from Data Object Imports the data file from a data object (class dataObj) and returns a data frame.
.parseMDLFile Parse MDL File
.resolveResultsDirectory Resolve Results Directory Resolves a directory where the results of the execution would be placed if the MDL file was executed.
.resolveResultsDirectory-method Resolve Results Directory Resolves a directory where the results of the execution would be placed if the MDL file was executed.
.rowEvaluate Evaluate Code within a Data Frame and Update Evaluates a string containing R code on each row of a data frame and returns an updated data frame.
.setFinalSubmissionStatus Set Final Submission Status