Learn R Programming

⚠️There's a newer version (0.7.0) of this package.Take me there.

PopED

PopED computes optimal experimental designs for both population and individual studies based on nonlinear mixed-effect models. Often this is based on a computation of the Fisher Information Matrix (FIM).

Installation

You need to have R installed. Download the latest version of R from www.r-project.org. You can install the released version of PopED from CRAN with:

install.packages("PopED")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("andrewhooker/PopED")

Getting started

To get started you need to define

  1. A model.
  2. An initial design (and design space if you want to optimize).
  3. The tasks to perform.

Learn more in this introduction to PopED

Contact

You are welcome to:

Copy Link

Version

Install

install.packages('PopED')

Monthly Downloads

606

Version

0.6.0

License

LGPL (>= 3)

Issues

Pull Requests

Stars

Forks

Maintainer

Andrew C. Hooker

Last Published

May 21st, 2021

Functions in PopED (0.6.0)

Doptim

D-family optimization function
blockfinal

Result function for optimization routines
PopED

PopED - Population (and individual) optimal Experimental Design.
LinMatrixL_occ

Model linearization with respect to occasion variability parameters.
bfgsb_min

Nonlinear minimization using BFGS with box constraints
blockexp

Summarize your experiment for optimization routines
model_prediction

Model predictions
feps.add

RUV model: Additive .
ofv_criterion

Normalize an objective function by the size of the FIM matrix
feps.add.prop

RUV model: Additive and Proportional.
poped_optim

Optimize a design defined in a PopED database
fileparts

MATLAB fileparts function
getTruncatedNormal

Generate a random sample from a truncated normal distribution.
poped_optim_1

Optimization main module for PopED Optimize the objective function. The function works for both discrete and continuous optimization variables. If more than one optimization method is specified then the methods are run in series. If loop_methods=TRUE then the series of optimization methods will be run for iter_max iterations, or until the efficiency of the design after the current series (compared to the start of the series) is less than stop_crit_eff.
create_design_space

Create design variables and a design space for a full description of an optimization problem.
feps.prop

RUV model: Proportional.
create_design

Create design variables for a full description of a design.
blockheader

Header function for optimization routines
shrinkage

Predict shrinkage of empirical Bayes estimates (EBEs) in a population model
randn

Function written to match MATLAB's randn function
tryCatch.W.E

tryCatch both warnings (with value) and errors
zeros

Create a matrix of zeros.
get_all_params

Extract all model parameters from the PopED database.
feval

MATLAB feval function
mc_mean

Compute the monte-carlo mean of a function
get_rse

Compute the expected parameter relative standard errors
pargen

Parameter simulation
median_hilow_poped

Wrap summary functions from Hmisc and ggplot to work with stat_summary in ggplot
optimize_n_rse

Optimize the number of subjects based on desired uncertainty of a parameter.
size

Function written to match MATLAB's size function
a_line_search

Optimize using line search
RS_opt

Optimize the objective function using an adaptive random search algorithm for D-family and E-family designs.
calc_ofv_and_grad

Compute an objective function and gradient
cell

Create a cell array (a matrix of lists)
start_parallel

Start parallel computational processes
design_summary

Display a summary of output from poped_db
LinMatrixL

The linearized matrix L
LinMatrixLH

Model linearization with respect to epsilon and eta.
diag_matlab

Function written to match MATLAB's diag function
blockopt

Summarize your optimization settings for optimization routines
create.poped.database

Create a PopED database
calc_autofocus

Compute the autofocus portion of the stochastic gradient routine
evaluate.e.ofv.fim

Evaluate the expectation of the Fisher Information Matrix (FIM) and the expectation of the OFV(FIM).
calc_ofv_and_fim

Calculate the Fisher Information Matrix (FIM) and the OFV(FIM) for either point values or parameters or distributions.
convert_variables

Create global variables in the PopED database
evaluate_design

Evaluate a design
ff.PK.1.comp.oral.md.CL

Structural model: one-compartment, oral absorption, multiple bolus dose, parameterized using CL.
isempty

Function written to match MATLAB's isempty function
build_sfg

Build PopED parameter function from a model function
ff.PK.1.comp.oral.md.KE

Structural model: one-compartment, oral absorption, multiple bolus dose, parameterized using KE.
evaluate_fim_map

Compute the Bayesian Fisher information matrix
downsizing_general_design

Downsize a general design to a specific design
evaluate.fim

Evaluate the Fisher Information Matrix (FIM)
ed_laplace_ofv

Evaluate the expectation of determinant the Fisher Information Matrix (FIM) using the Laplace approximation.
getfulld

Create a full D (between subject variability) matrix given a vector of variances and covariances. Note, this does not test matching vector lengths.
ff.PKPD.1.comp.sd.CL.emax

Structural model: one-compartment, single bolus IV dose, parameterized using CL driving an EMAX model with a direct effect.
ff.PKPD.1.comp.oral.md.CL.imax

Structural model: one-compartment, oral absorption, multiple bolus dose, parameterized using CL driving an inhibitory IMAX model with a direct effect.
ff.PK.1.comp.oral.sd.CL

Structural model: one-compartment, oral absorption, single bolus dose, parameterized using CL.
get_unfixed_params

Return all the unfixed parameters
ff.PK.1.comp.oral.sd.KE

Structural model: one-compartment, oral absorption, single bolus dose, parameterized using KE.
mftot

Evaluate the Fisher Information Matrix (FIM)
mfea

Modified Fedorov Exchange Algorithm
optimize_n_eff

Translate efficiency to number of subjects
optimize_groupsize

Title Optimize the proportion of individuals in the design groups
mf7

The full Fisher Information Matrix (FIM) for one individual Calculating one model switch at a time, good for large matrices.
log_prior_pdf

Compute the natural log of the PDF for the parameters in an E-family design
optim_ARS

Optimize a function using adaptive random search.
mf3

The Fisher Information Matrix (FIM) for one individual
poped.choose

Choose between arg1 and arg2
plot_efficiency_of_windows

Plot the efficiency of windows
poped_gui

Run the graphical interface for PopED
LEDoptim

Optimization function for D-family, E-family and Laplace approximated ED designs
LinMatrixH

Model linearization with respect to epsilon.
optim_LS

Optimize a function using a line search algorithm.
ed_mftot

Evaluate the expectation of the Fisher Information Matrix (FIM) and the expectation of the OFV(FIM).
summary.poped_optim

Display a summary of output from poped_optim
efficiency

Compute efficiency.
plot_model_prediction

Plot model predictions
poped_optim_2

Optimization main module for PopED
test_mat_size

Test to make sure that matricies are the right size
poped_optim_3

Optimization main module for PopED
tic

Timer function (as in MATLAB)
toc

Timer function (as in MATLAB)
evaluate_power

Power of a design to estimate a parameter.
extract_norm_group_fim

Extract a normalized group FIM
gradf_eps

Model linearization with respect to epsilon.
inv

Compute the inverse of a matrix
rand

Function written to match MATLAB's rand function
ones

Create a matrix of ones
ofv_fim

Evaluate a criterion of the Fisher Information Matrix (FIM)
poped_optimize

Retired optimization module for PopED
Dtrace

Trace optimization routines