simpopmlx: Population parameters simulation

View source: R/simpop.R

simpopmlxR Documentation

Population parameters simulation

Description

Draw population parameters using the covariance matrix of the estimates

Usage

simpopmlx(
  n = 1,
  project = NULL,
  fim = NULL,
  parameter = NULL,
  corr = NULL,
  kw.max = 100,
  outputFilename = NULL,
  sep = ",",
  seed = NULL
)

Arguments

n

(integer) the number of vectors of population parameters (default = 1),

project

(string) a Monolix project, assuming that the Fisher information Matrix was estimated by Monolix.

fim

the (string) Fisher Information Matrix estimated by Monolix. fim = c("sa", "lin") (default="sa")

parameter

(data.frame) a data frame with the following columns

  • pop.param (no default) population parameters

  • sd (no default) standard deviation of the distribution

  • trans (default ='N') distribution (N: normal, L: logNormal, G: logitnormal, P: probitnormal, R)

  • lim.a: lower bound of logit distribution (if trans != G set lim.a to NA)

  • lim.b: upper bound of logit distribution (if trans != G set lim.b to NA)

Only when project is not used.

corr

(matrix) correlation matrix of the population parameters (default = identity). Only when project is not used.

kw.max

(integer) maximum number of trials for generating a positive definite covariance matrix (default = 100)

outputFilename

(string) when defined, path where the population parameters dataframe will be saved It must be a a file with a csv or txt extension. If no extension is specified, file will be saved by default in csv format

sep

(string) file separator when outputFilename is defined (default = ",")

seed

(integer) initialization of the random number generator (integer) (by default a random seed will be generated)

Details

See http://simulx.webpopix.org/mlxr/simpopmlx/ for more details.

Value

dataframe object with generated population parameters

Examples

## Not run: 
param <- data.frame(pop.param=c(1.5, 0.5, 0.02, 0.4, 0.15, 0.2, 0.7),
                    sd=c(0.2, 0.05, 0.004, 0.05, 0.02, 0.02, 0.05),
                    trans=c('N','N','N','L','L','L','N'))
pop <- simpopmlx(n=3, parameter=param)

## End(Not run)

RsSimulx documentation built on June 22, 2024, 9:36 a.m.

Related to simpopmlx in RsSimulx...