Learn R Programming

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

PopED: Population (and individual) Experimental Design in R

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. Install PopED in R using one of the following methods:

  • latest stable release -- From CRAN. Write at the R command line:
install.packages("PopED")
  • Latest development version -- from Github. Note that the command below installs the "master"

(development) branch; if you want the release branch from Github add ref="release" to the install_github() call. The install_github() approach requires that you build from source, i.e. make and compilers must be installed on your system -- see the R FAQ for your operating system; you may also need to install dependencies manually.

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.

There are a number of functions to help you with these tasks. See ?poped for more information.

There are several other examples, as r-scripts, in the "examples" folder in the PopED installation directory located at:

system.file("examples", package="PopED")

The same examples are located in the "inst/examples" directory of this repository.

Copy Link

Version

Install

install.packages('PopED')

Monthly Downloads

606

Version

0.3.2

License

LGPL (>= 3)

Maintainer

Andrew C Hooker

Last Published

December 12th, 2016

Functions in PopED (0.3.2)

bfgsb_min

Nonlinear minimization using BFGS with box constraints
blockfinal

Result function for optimization routines
calc_autofocus

Compute the autofocus portion of the stochastic gradient routine
a_line_search

Optimize using line search
blockopt

Summarize your optimization settings for optimization routines
blockexp

Summarize your experiment for optimization routines
blockheader

Header function for optimization routines
cell

Create a cell array (a matrix of lists)
calc_ofv_and_grad

Compute an objective function and gradient
calc_ofv_and_fim

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

Trace optimization routines
ed_laplace_ofv

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

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

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

Create design variables and a design space for a full decription of an optimization problem.
diag_matlab

Function written to match MATLAB's diag function
Doptim

D-family optimization function
create.poped.database

Create a PopED database
downsizing_general_design

Downsize a general design to a specific design
convert_variables

Create global variables in the PopED database
efficiency

Compute efficiency.
evaluate.e.ofv.fim

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

MATLAB feval function
evaluate.fim

Evaluate the Fisher Information Matrix (FIM)
feps.add

RUV model: Additive .
ff.PK.1.comp.oral.md.CL

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

RUV model: Additive and Proportional.
evaluate_design

Evaluate a design
feps.prop

RUV model: Proportional.
ff.PK.1.comp.oral.md.KE

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

Compute the expected parameter relative standard errors
ff.PKPD.1.comp.oral.md.CL.imax

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

Structural model: one-compartment, oral absorption, single bolus dose, parameterized using KE.
ff.PK.1.comp.oral.sd.CL

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

Create a full D (between subject variability) matrix given a vector of variances and covariances.
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 efect.
fileparts

MATLAB fileparts function
get_unfixed_params

Return all the unfixed parameters
get_all_params

Extract all model parameters from the PopED database.
getTruncatedNormal

Generate a random sample from a truncated normal distribution.
LinMatrixLH

Model linearization with respect to epsilon and eta.
gradf_eps

Model linearization with respect to epsilon.
LinMatrixL_occ

Model linearization with respect to occasion variablity parameters.
inv

Compute the inverse of a matrix
isempty

Function written to match MATLAB's isempty function
LEDoptim

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

Function written to match MATLAB's isfield function
LinMatrixH

Model linearization with respect to epsilon.
LinMatrixL

The linearized matrix L
log_prior_pdf

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

Modified Federov Exchange Algorithm
mf6

The full Fisher Information Matrix (FIM) for one individual parameterized with A,B,C matrices & using the derivative of variance.
mf5

The reduced Fisher Information Matrix (FIM) for one individual, using the SD of RUV as a parameter.
mc_mean

Compute the monte-carlo mean of a function
mf7

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

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

The reduced Fisher Information Matrix (FIM) for one individual parameterized with A,B,C matrices & using the derivative of variance.
mf3

The reduced Fisher Information Matrix (FIM) for one individual
mf

The full Fisher Information Matrix (FIM) for one individual
mftot

Evaluate the Fisher Information Matrix (FIM)
mftot2

The Fisher Information Matrix (FIM) using weighted models
ofv_criterion

Normalize an objective function by the size of the FIM matrix
model_prediction

Model predictions
mftot0

The full Fisher Information Matrix (FIM)
mftot1

The reduced Fisher Information Matrix (FIM)
mftot6

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

The full Fisher Information Matrix (FIM) parameterized with A,B,C matrices & using the derivative of variance.
mftot4

The reduced Fisher Information Matrix (FIM) using the SD of RUV as a parameter.
mftot3

The Fisher Information Matrix (FIM) some other method
mftot7

The reduced Fisher Information Matrix (FIM) parameterized with A,B,C matrices & using the derivative of variance.
ones

Creates a matrix of ones
pargen

Parameter simulation
plot_model_prediction

Plot model predictions
ofv_fim

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

Run the graphical interface for PopED
optim_LS

Optimization Using a Line Search Algorithm.
plot_efficiency_of_windows

Plot the efficiency of windows
optim_ARS

Optimization Using Adaptive Random Search.
poped_optimize

Optimization main module for PopED
poped_optim

Optimization main module for PopED
RS_opt

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

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

Function written to match MATLAB's rand function
randperm

Function written to match MATLAB's randperm function
randn

Function written to match MATLAB's randn function
start_parallel

Start parallel computational processes
summary.poped_optim

Display a summary of output from poped_optim
poped.choose

Choose between arg1 and arg2
PopED

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

Function written to match MATLAB's size function
tic

Timer function (as in MATLAB)
toc

Timer function (as in MATLAB)
zeros

Creates a matrix of zeros.
test_for_zeros

Test if any matrix element is zero.
test_for_min

Test if any matrix element is above a minimum value.
test_for_max

Test if any matrix element is above a max value.
test_mat_size

Test to make sure that matricies are the right size