diff options
Diffstat (limited to 'man')
-rw-r--r-- | man/nlme.Rd | 11 | ||||
-rw-r--r-- | man/saem.Rd | 19 |
2 files changed, 26 insertions, 4 deletions
diff --git a/man/nlme.Rd b/man/nlme.Rd index 307cca82..c367868b 100644 --- a/man/nlme.Rd +++ b/man/nlme.Rd @@ -8,7 +8,7 @@ \usage{ nlme_function(object) -mean_degparms(object, random = FALSE) +mean_degparms(object, random = FALSE, test_log_parms = FALSE, conf.level = 0.6) nlme_data(object) } @@ -16,6 +16,13 @@ nlme_data(object) \item{object}{An mmkin row object containing several fits of the same model to different datasets} \item{random}{Should a list with fixed and random effects be returned?} + +\item{test_log_parms}{If TRUE, log parameters are only considered in +the mean calculations if their untransformed counterparts (most likely +rate constants) pass the t-test for significant difference from zero.} + +\item{conf.level}{Possibility to adjust the required confidence level +for parameter that are tested if requested by 'test_log_parms'.} } \value{ A function that can be used with nlme @@ -60,7 +67,7 @@ grouped_data <- nlme_data(f) nlme_f <- nlme_function(f) # These assignments are necessary for these objects to be # visible to nlme and augPred when evaluation is done by -# pkgdown to generated the html docs. +# pkgdown to generate the html docs. assign("nlme_f", nlme_f, globalenv()) assign("grouped_data", grouped_data, globalenv()) diff --git a/man/saem.Rd b/man/saem.Rd index d5a8f17e..45f74e44 100644 --- a/man/saem.Rd +++ b/man/saem.Rd @@ -14,9 +14,12 @@ saem(object, ...) object, transformations = c("mkin", "saemix"), degparms_start = numeric(), + test_log_parms = FALSE, + conf.level = 0.6, solution_type = "auto", control = list(displayProgress = FALSE, print = FALSE, save = FALSE, save.graphs = FALSE), + fail_with_errors = TRUE, verbose = FALSE, quiet = FALSE, ... @@ -29,6 +32,7 @@ saemix_model( solution_type = "auto", transformations = c("mkin", "saemix"), degparms_start = numeric(), + test_log_parms = FALSE, verbose = FALSE, ... ) @@ -50,11 +54,22 @@ SFO or DFOP is used for the parent and there is either no metabolite or one.} \item{degparms_start}{Parameter values given as a named numeric vector will be used to override the starting values obtained from the 'mmkin' object.} +\item{test_log_parms}{If TRUE, an attempt is made to use more robust starting +values for population parameters fitted as log parameters in mkin (like +rate constants) by only considering rate constants that pass the t-test +when calculating mean degradation parameters using \link{mean_degparms}.} + +\item{conf.level}{Possibility to adjust the required confidence level +for parameter that are tested if requested by 'test_log_parms'.} + \item{solution_type}{Possibility to specify the solution type in case the automatic choice is not desired} \item{control}{Passed to \link[saemix:saemix]{saemix::saemix}} +\item{fail_with_errors}{Should a failure to compute standard errors +from the inverse of the Fisher Information Matrix be a failure?} + \item{verbose}{Should we print information about created objects of type \link[saemix:SaemixModel-class]{saemix::SaemixModel} and \link[saemix:SaemixData-class]{saemix::SaemixData}?} @@ -104,7 +119,7 @@ f_saem_dfop <- saem(f_mmkin_parent["DFOP", ]) # The returned saem.mmkin object contains an SaemixObject, therefore we can use # functions from saemix library(saemix) -compare.saemix(list(f_saem_sfo$so, f_saem_fomc$so, f_saem_dfop$so)) +compare.saemix(f_saem_sfo$so, f_saem_fomc$so, f_saem_dfop$so) plot(f_saem_fomc$so, plot.type = "convergence") plot(f_saem_fomc$so, plot.type = "individual.fit") plot(f_saem_fomc$so, plot.type = "npde") @@ -112,7 +127,7 @@ plot(f_saem_fomc$so, plot.type = "vpc") f_mmkin_parent_tc <- update(f_mmkin_parent, error_model = "tc") f_saem_fomc_tc <- saem(f_mmkin_parent_tc["FOMC", ]) -compare.saemix(list(f_saem_fomc$so, f_saem_fomc_tc$so)) +compare.saemix(f_saem_fomc$so, f_saem_fomc_tc$so) sfo_sfo <- mkinmod(parent = mkinsub("SFO", "A1"), A1 = mkinsub("SFO")) |