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. Set to NULL (or any zero-length value) to skip confidence intervals.

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: 5 × 12
#>   type  name  label   value      se     rse fixed diagonal     m     n `2.5% CI`
#>   <chr> <chr> <chr>   <dbl>   <dbl>   <dbl> <lgl> <lgl>    <int> <int>     <dbl>
#> 1 the   THET… tvV   22.9    1.841   0.08042 FALSE NA           1    NA   19.25  
#> 2 the   THET… tvCl  11.69   1.242   0.1062  FALSE NA           2    NA    9.23  
#> 3 sig   SIGM… CEps   1.283  0.1061  0.0827  FALSE TRUE         1     1    1.073 
#> 4 ome   OMEG… nV     0.6985 0.02663 0.03813 FALSE TRUE         1     1    0.6457
#> 5 ome   OMEG… nCl    0.6905 0.02399 0.03475 FALSE TRUE         2     2    0.643 
#> # ℹ 1 more variable: `97.5% CI` <dbl>