MonolixSuite in R
Auto Light Dark
Auto Light Dark

listingAbbreviation()

Produces an abbreviation listing of the computed NCA parameters of a PKanalix project, one row per parameter, pairing each parameter's abbreviation (its alias where one is defined, otherwise the original parameter name) with an optional full-term definition. The full set of computed parameters is always kept, rows are de-duplicated and sorted.

Usage

R
listingAbbreviation(projectFile   = NULL,
                    aliases       = TRUE,
                    customAliases = NULL,
                    fullTerms     = NULL)

Arguments

  • projectFile (character) Path to the PKanalix project file (.pkx). If NULL (default), the currently loaded project is used.

  • aliases (logical) If TRUE (default), the Abbreviation column shows each parameter's alias where one exists, falling back to the original parameter name otherwise (so a mix of aliases and raw names is expected when only some parameters have an alias). Aliases come from customAliases when supplied, otherwise they are fetched from the project. HTML <sub>text</sub> markup in aliases is converted for flextable rendering. If FALSE, the original parameter names are used.

  • customAliases (named vector/ data.frame) Optional custom alias mapping used instead of the project aliases. Either a named vector (e.g. c(Cmax = "C<sub>max</sub>")) or a 2-column data frame whose first column holds the parameter names and second column the aliases. Keyed on the original parameter names.

  • fullTerms (named vector/ data.frame) Optional mapping used to fill the Full term column, keyed on the original parameter names. Same accepted forms as customAliases: a named vector (e.g. c(Cmax = "Maximum concentration")) or a 2-column data frame (parameter, full term). Parameters without an entry stay empty. If NULL (default), the Full term column is left empty

Examples

NCA parameter abbreviation listing with full-term definitions

R
loadProject(paste0(getDemoPath(),"/1.basic_examples/project_nominal_time.pkx"))
runNCAEstimation()

listingAbbreviation(
  aliases = TRUE,
  fullTerms = c(
    AUCINF_obs         = "Area under the curve from zero extrapolated to infinity (observed)",  
    AUClast            = "Area under the curve from zero to the last measurable concentration", 
    Cl_F_obs           = "Apparent total clearance (observed)",                                 
    Clast              = "Last measurable (observed) concentration"
  ))

#>       Abbreviation                                                           Full term
#>   AUC[[sub:0-inf]]  Area under the curve from zero extrapolated to infinity (observed)
#> AUC[[sub:0-tlast]] Area under the curve from zero to the last measurable concentration
#>              CL/F                                 Apparent total clearance (observed)
#>      C[[sub:last]]                            Last measurable (observed) concentration
#>       C[[sub:max]]                                                                <NA>
#>        k[[sub:el]]                                                                <NA>
#>          Intercept                                                                <NA>
#>   Number of points                                                                <NA>
#>          R squared                                                                <NA>
#> adjusted R squared                                                                <NA>
#>      T[[sub:last]]                                                                <NA>
#>       T[[sub:max]]                                                                <NA>
#>       V[[sub:d]]/F                                                                <NA>

NCA parameter abbreviation listing with full-term definitions and original parameter names

R
loadProject(paste0(getDemoPath(),"/1.basic_examples/project_nominal_time.pkx"))
runNCAEstimation()

listingAbbreviation(
  aliases = FALSE,
  fullTerms = c(
    AUCINF_obs         = "Area under the curve from zero extrapolated to infinity (observed)",  
    AUClast            = "Area under the curve from zero to the last measurable concentration", 
    Cl_F_obs           = "Apparent total clearance (observed)",                                 
    Clast              = "Last measurable (observed) concentration",                            
    Cmax               = "Maximum observed concentration",                                      
    Lambda_z           = "Terminal elimination rate constant",                                  
    Lambda_z_intercept = "Intercept of the terminal log-linear regression",                     
    No_points_lambda_z = "Number of points used in the lambda_z regression",                    
    Rsq                = "Coefficient of determination (R2) of the lambda_z regression",        
    Rsq_adjusted       = "Adjusted coefficient of determination of the lambda_z regression",    
    Tlast              = "Time of the last measurable concentration",                           
    Tmax               = "Time of maximum observed concentration",                              
    Vz_F_obs           = "Apparent volume of distribution during the terminal phase (observed)" 
  ))

#>        Abbreviation                                                            Full term
#>          AUCINF_obs   Area under the curve from zero extrapolated to infinity (observed)
#>             AUClast  Area under the curve from zero to the last measurable concentration
#>            Cl_F_obs                                  Apparent total clearance (observed)
#>               Clast                             Last measurable (observed) concentration
#>                Cmax                                       Maximum observed concentration
#>            Lambda_z                                   Terminal elimination rate constant
#>  Lambda_z_intercept                      Intercept of the terminal log-linear regression
#>  No_points_lambda_z                     Number of points used in the lambda_z regression
#>                 Rsq         Coefficient of determination (R2) of the lambda_z regression
#>        Rsq_adjusted     Adjusted coefficient of determination of the lambda_z regression
#>               Tlast                            Time of the last measurable concentration
#>                Tmax                               Time of maximum observed concentration
#>            Vz_F_obs Apparent volume of distribution during the terminal phase (observed)

NCA parameter abbreviation listing with custom abbreviations and full-term definitions

R
loadProject(paste0(getDemoPath(),"/1.basic_examples/project_nominal_time.pkx"))
runNCAEstimation()

head(
  listingAbbreviation(
    customAliases = c(Cmax    = "C<sub>max</sub>",
                      AUClast = "AUC<sub>0-t</sub>",
                      Cl_F_obs= "Cl<sub>tot,obs</sub>"),
    fullTerms = c(
      AUCINF_obs         = "Area under the curve from zero extrapolated to infinity (observed)",  
      AUClast            = "Area under the curve from zero to the last measurable concentration", 
      Cl_F_obs           = "Apparent total clearance (observed)",                                 
      Clast              = "Last measurable (observed) concentration"
    ))
)
#>      Abbreviation                                                           Full term
#>        AUCINF_obs  Area under the curve from zero extrapolated to infinity (observed)
#>    AUC[[sub:0-t]] Area under the curve from zero to the last measurable concentration
#> Cl[[sub:tot,obs]]                                 Apparent total clearance (observed)
#>             Clast                            Last measurable (observed) concentration
#>      C[[sub:max]]                                                                <NA>
#>          Lambda_z                                                                <NA>

Last updated: