From e5d1df9a9b1f0951d7dfbaf24eee4294470b73e2 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 17 Nov 2022 14:54:20 +0100 Subject: Complete update of online docs for v1.2.0 --- docs/reference/parms.html | 122 ++++++++++++++++++++++++++++------------------ 1 file changed, 75 insertions(+), 47 deletions(-) (limited to 'docs/reference/parms.html') diff --git a/docs/reference/parms.html b/docs/reference/parms.html index 18f3566e..a3d62d1e 100644 --- a/docs/reference/parms.html +++ b/docs/reference/parms.html @@ -1,7 +1,7 @@ -Extract model parameters from mkinfit models — parms • mkinExtract model parameters — parms • mkin @@ -19,7 +19,7 @@ considering the error structure that was assumed for the fit.">< mkin - 1.1.0 + 1.2.0 @@ -46,11 +46,14 @@ considering the error structure that was assumed for the fit.">< Example evaluations of dimethenamid data from 2018 with nonlinear mixed-effects models
  • - Example evaluation of FOCUS Example Dataset Z + Short demo of the multistart method
  • Performance benefit by using compiled model definitions in mkin
  • +
  • + Example evaluation of FOCUS Example Dataset Z +
  • Calculation of time weighted average concentrations with mkin
  • @@ -58,7 +61,10 @@ considering the error structure that was assumed for the fit.">< Example evaluation of NAFTA SOP Attachment examples
  • - Some benchmark timings + Benchmark timings for mkin +
  • +
  • + Benchmark timings for saem.mmkin
  • @@ -79,69 +85,91 @@ considering the error structure that was assumed for the fit."><
    -

    This function always returns degradation model parameters as well as error -model parameters, in order to avoid working with a fitted model without -considering the error structure that was assumed for the fit.

    +

    This function returns degradation model parameters as well as error +model parameters per default, in order to avoid working with a fitted model +without considering the error structure that was assumed for the fit.

    -
    parms(object, ...)
    -
    -# S3 method for mkinfit
    -parms(object, transformed = FALSE, ...)
    -
    -# S3 method for mmkin
    -parms(object, transformed = FALSE, ...)
    +
    parms(object, ...)
    +
    +# S3 method for mkinfit
    +parms(object, transformed = FALSE, errparms = TRUE, ...)
    +
    +# S3 method for mmkin
    +parms(object, transformed = FALSE, errparms = TRUE, ...)
    +
    +# S3 method for multistart
    +parms(object, exclude_failed = TRUE, ...)

    Arguments

    object
    -

    A fitted model object. Methods are implemented for -mkinfit() objects and for mmkin() objects.

    +

    A fitted model object.

    + +
    ...

    Not used

    + +
    transformed
    -

    Should the parameters be returned -as used internally during the optimisation?

    +

    Should the parameters be returned as used internally +during the optimisation?

    + + +
    errparms
    +

    Should the error model parameters be returned +in addition to the degradation parameters?

    + + +
    exclude_failed
    +

    For multistart objects, should rows for failed fits +be removed from the returned parameter matrix?

    +

    Value

    -

    For mkinfit objects, a numeric vector of fitted model parameters. -For mmkin row objects, a matrix with the parameters with a -row for each dataset. If the mmkin object has more than one row, a list of -such matrices is returned.

    + + +

    Depending on the object, a numeric vector of fitted model parameters, +a matrix (e.g. for mmkin row objects), or a list of matrices (e.g. for +mmkin objects with more than one row).

    +
    +
    +

    See also

    +

    Examples

    -
    # mkinfit objects
    -fit <- mkinfit("SFO", FOCUS_2006_C, quiet = TRUE)
    -parms(fit)
    +    
    # mkinfit objects
    +fit <- mkinfit("SFO", FOCUS_2006_C, quiet = TRUE)
    +parms(fit)
     #>   parent_0   k_parent      sigma 
     #> 82.4921598  0.3060633  4.6730124 
    -parms(fit, transformed = TRUE)
    +parms(fit, transformed = TRUE)
     #>     parent_0 log_k_parent        sigma 
     #>    82.492160    -1.183963     4.673012 
    -
    -# mmkin objects
    -ds <- lapply(experimental_data_for_UBA_2019[6:10],
    - function(x) subset(x$data[c("name", "time", "value")]))
    -names(ds) <- paste("Dataset", 6:10)
    -# \dontrun{
    -fits <- mmkin(c("SFO", "FOMC", "DFOP"), ds, quiet = TRUE, cores = 1)
    -parms(fits["SFO", ])
    +
    +# mmkin objects
    +ds <- lapply(experimental_data_for_UBA_2019[6:10],
    + function(x) subset(x$data[c("name", "time", "value")]))
    +names(ds) <- paste("Dataset", 6:10)
    +# \dontrun{
    +fits <- mmkin(c("SFO", "FOMC", "DFOP"), ds, quiet = TRUE, cores = 1)
    +parms(fits["SFO", ])
     #>            Dataset 6    Dataset 7  Dataset 8  Dataset 9  Dataset 10
     #> parent_0 88.52275400 82.666781678 86.8547308 91.7779306 82.14809450
     #> k_parent  0.05794659  0.009647805  0.2102974  0.1232258  0.00720421
     #> sigma     5.15274487  7.040168584  3.6769645  6.4669234  6.50457673
    -parms(fits[, 2])
    +parms(fits[, 2])
     #> $SFO
     #>             Dataset 7
     #> parent_0 82.666781678
    @@ -157,13 +185,13 @@ such matrices is returned.

    #> #> $DFOP #> Dataset 7 -#> parent_0 91.058971599 +#> parent_0 91.058971589 #> k1 0.044946770 #> k2 0.002868336 -#> g 0.526942414 +#> g 0.526942415 #> sigma 2.221302196 #> -parms(fits) +parms(fits) #> $SFO #> Dataset 6 Dataset 7 Dataset 8 Dataset 9 Dataset 10 #> parent_0 88.52275400 82.666781678 86.8547308 91.7779306 82.14809450 @@ -179,13 +207,13 @@ such matrices is returned.

    #> #> $DFOP #> Dataset 6 Dataset 7 Dataset 8 Dataset 9 Dataset 10 -#> parent_0 96.55213663 91.058971599 90.34509493 98.14858821 94.311323732 +#> parent_0 96.55213663 91.058971589 90.34509493 98.14858820 94.311323734 #> k1 0.21954588 0.044946770 0.41232288 0.31697588 0.080663857 #> k2 0.02957934 0.002868336 0.07581766 0.03260384 0.003425417 -#> g 0.44845068 0.526942414 0.66091967 0.65322767 0.342652880 +#> g 0.44845068 0.526942415 0.66091967 0.65322767 0.342652880 #> sigma 1.35690468 2.221302196 1.34169076 2.87159846 1.942067831 #> -parms(fits, transformed = TRUE) +parms(fits, transformed = TRUE) #> $SFO #> Dataset 6 Dataset 7 Dataset 8 Dataset 9 Dataset 10 #> parent_0 88.522754 82.666782 86.854731 91.777931 82.148094 @@ -207,7 +235,7 @@ such matrices is returned.

    #> g_qlogis -0.2069326 0.1078741 0.6673953 0.6332573 -0.6514943 #> sigma 1.3569047 2.2213022 1.3416908 2.8715985 1.9420678 #> -# } +# }
    @@ -222,7 +250,7 @@ such matrices is returned.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.6.

    -- cgit v1.2.1