Skip to contents

Access NLME model parameter estimates

get_prmNlme.Rd

Access model parameter estimates from an xpdb object generated by xposeNlme.

Usage

get_prmNlme(
  xpdb,
  .problem = 1,
  .subprob = 0,
  .method = NULL,
  digits = 6,
  show_all = FALSE,
  level = 0.95
)

Arguments

xpdb

An xpose data base object from which the model output file data will be extracted. Only objects generated by xposeNlme are supported.

.problem

The problem to be used.

.subprob

The subproblem to be used.

.method

The estimation method to be used.

digits

Integer specifying the number of significant digits to be displayed.

show_all

Logical specifying whether the 0 off-diagonal omega elements should be removed from the output or not.

level

Numeric specifying confidence level to compute confidence intervals, which are calculated based on Student’s t distribution.

Value

A tibble for single problem/subproblem.

See also

xposeNlme

Examples

# Store the parameter table
prm <- get_prmNlme(xpdb_ex_Nlme)

# Set the desired number of significant digits to display results

# Note: To have results displayed in the number of significant digits
#  specified in the digits argument, one needs to make sure that
#  the value of pillar.sigfig option (default value is 3) is greater
#  than or equal to this specified value.

options(pillar.sigfig = 6)
get_prmNlme(xpdb_ex_Nlme, digits = 4)
#> # A tibble: 3 × 12
#>   type  name       label   value        se      rse fixed diagonal     m     n
#>   <chr> <chr>      <chr>   <dbl>     <dbl>    <dbl> <lgl> <lgl>    <int> <int>
#> 1 sig   SIGMA(1,1) CEps  0.09436  0.002428  0.02573 FALSE TRUE         1     1
#> 2 ome   OMEGA(1,1) nV    0.1261  NA        NA       FALSE TRUE         1     1
#> 3 ome   OMEGA(2,2) nCl   0.07976 NA        NA       FALSE TRUE         2     2
#> # ℹ 2 more variables: `2.5% CI` <dbl>, `97.5% CI` <dbl>