Skip to contents

Makes nlmixr2 Parameter Estimate Table for Reporting

Source: R/build_tables.R
gen_pest_table.Rd

Generates a flextable containting the parameter estimates.

Usage

gen_pest_table(obnd = NULL, fit = NULL, rptdetails = NULL, verbose = TRUE)

Arguments

obnd

onbrand report object to have report elements appended to

fit

nlmixr2 fit object to be reported

rptdetails

object creating when reading in rptyaml file

verbose

Boolean variable when set to TRUE (default) messages will be displayed on the terminal

Value

List with the following elements

  • "isgood" - Boolean variable indicating success or failure

  • "msgs" - Vector of messages

  • "ft" - Parameter estimates as a flextable object

  • "df" - Parameter estimates as a data.frame

Examples

library(onbrand)  
obnd = read_template(
 template = system.file(package="nlmixr2rpt", "templates","nlmixr_obnd_template.pptx"),
 mapping  = system.file(package="nlmixr2rpt", "templates","nlmixr_obnd_template.yaml"))

# This will create an example fit object to use in the examples below
fit = fetch_fit_example()

#'# This reads in the report details as well
rptdetails = yaml_read_fit(
 obnd    = obnd,
 rptyaml = system.file(package="nlmixr2rpt", "examples", "report_fit_test.yaml"),
 fit     = fit)$rptdetails

gen_pest_table(obnd = obnd, fit = fit, rptdetails = rptdetails, verbose = TRUE)
#> $isgood
#> [1] TRUE
#> 
#> $msgs
#> NULL
#> 
#> $ft
#> $ft[[1]]
#> 
#> 
#> $df
#> $df[[1]]
#>        Parameter  Est.     SE %RSE Back-transformed(95%CI) BSV(CV%) Shrink(SD)%
#> tka       Log Ka 0.476  0.203 42.7       1.61 (1.08, 2.39)     69.8      1.23%<
#> tcl       Log Cl  1.02 0.0754 7.42        2.76 (2.38, 3.2)     26.1      2.36%<
#> tv         Log V  3.46 0.0632 1.83         31.8 (28.1, 36)     13.8      9.71%<
#> add.sd    add.sd 0.696                               0.696                     
#> 
#>