Create Probability of Target Attainment (PTA) object

This object class contains results of simulations and a probability of target attainment analysis.

Details

#' There are two ways of creating a PM_pta object.

• PM_sim$pta() This way uses the simulation method directly from a PM_sim object.

• PM_pta$new() This way takes an external PM_sim result as an argument and creates the PTA. It is described here.

Both methods require the prior creation of a simulation of appropriate regimens. They use makePTA to create the PM_pta object.

Author

Julian Otalvaro and Michael Neely

Public fields

results

Contains the raw results. See makePTA.

Methods

Public methods

• PM_pta$new()

• PM_pta$save()

• PM_pta$summary()

• PM_pta$plot()

• PM_pta$load()

• PM_pta$clone()

---

Method new()

Create a new PM_pta object.

Usage

PM_pta$new(simdata, target, target_type, success, ...)

Arguments

simdata

One of two possibilities:

• A PM_sim object, which typically will contain the results of multiple simulations OR

• The quoted filename of a previously saved .rds file (saved with the $save method below) in the current working directory (or the path plus filename) with results of a prior PTA analysis.

target

See makePTA.

target_type

See makePTA.

success

See makePTA

...

Other arguments passed to makePTA.

---

Method save()

Save the current PM_pta object into a .rds file.

Usage

PM_pta$save(file_name = "PMpta.rds")

Arguments

file_name

Name of the file to be created, the default is PMpta.rds

---

Method summary()

Summarize the PM_pta object. See summary.PMpta.

Usage

PM_pta$summary(...)

Arguments

...

Arguments passed to summary.PMpta

---

Method plot()

Plot the PM_pta object. See plot.PM_pta.

Usage

PM_pta$plot(...)

Arguments

...

Arguments passed to plot.PM_pta

---

Method load()

Deprecated method to load a prior PTA Replaced by PM_pta$new() to be consistent with R6.

Usage

PM_pta$load(...)

Arguments

...

Not used.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PM_pta$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.