Skip to contents

Population predictions at short intervals

Source: R/PM_pop.R
PM_pop.Rd

[Stable]

Contains the population predictions at short intervals specified as an argument to the run method of PM_fit. Default is every 12 minutes.

Details

#' The PM_pop object is both a data field within a PM_result, and itself an R6 object comprising data fields and associated methods suitable for analysis and plotting of population predictions generated during the run.

Because PM_pop objects are automatically added to the PM_result at the end of a successful run, it is generally not necessary for users to generate PM_pop objects themselves.

The main results are contained in the $data field, and it is this field which is passed to the $plot and $summary methods. data frame with population predicted outputs for all subjects.

To provide a more traditional experience in R, the data frame is separated by columns into fields, e.g. id or time. This allows you to access them in an S3 way, e.g. run1$pop$time if run1 is a PM_result object.

However, if you wish to manipulate the entire data frame, use the data field, e.g. trough <- run1$pop$data %>% filter(time == 24). If you are unfamiliar with the %>% pipe function, please type help("%>%", "magrittr") into the R console and look online for instructions/tutorials in tidyverse, a powerful approach to data manipulation upon which Pmetrics is built.

Author

Michael Neely, Julian Otalvaro

Public fields

data

A data frame with the following columns:

  • id Subject id

  • time Time of predictions in decimal hours

  • icen Prediction based on mean or median of Bayesian posterior parameter distribution

  • outeq Output equation number

  • pred Predicted output for each outeq

  • block Observation blocks within subjects as defined by EVID=4 dosing events

Methods

Public methods

Method new()

Create new object populated with population predicted data at regular, frequent intervals

Usage

PM_pop$new(PMdata = NULL, path = ".", ...)

Arguments

PMdata

include Saved, parsed output of prior run, used when source files are not available. .

path

include Path to the folder containing the raw results of the run. Default is the current working directory. .

...

Not currently used.

Details

Creation of new PM_pop object is automatic and not generally necessary for the user to do.

Method plot()

Plot method

Usage

PM_pop$plot(...)

Arguments

...

Arguments passed to plot.PM_pop

Details

See plot.PM_pop.

Method summary()

Summary method

Usage

PM_pop$summary(...)

Arguments

...

Arguments passed to summary.PM_pop

Details

See summary.PM_pop.

Method auc()

Calculate AUC

Usage

PM_pop$auc(...)

Arguments

...

Arguments passed to makeAUC

data

The object to use for AUC calculation

Details

See makeAUC

Method clone()

The objects of this class are cloneable with this method.

Usage

PM_pop$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.