AllPKParameters: All possible PK parameters for 'extractPK' (version for...

In shirewoman2/Consultancy: Standardized tools for using R within the Simcyp Consultancy Team

All possible PK parameters for extractPK (version for coding purposes)

Description

All possible PK parameters that can be extracted from a simulator output file using extractPK. For the more user-friendly version of this data.frame, which omits columns used only for coding purposes, please see PKParameterDefinitions.

Usage

AllPKParameters

Format

A data.frame with 6 columns:

PKparameter

the PK parameter name to use with extractPK for the argument PKparameters

BasePKparameter

PKparameter without any mention of whether it was in the presence of a perpetrator

PKparameter_nodosenum

PKparameter without any mention of the dose number. This is for matching up prettified names when the user has requested that no dose number be shown, e.g., when all the doses were for dose 1, it's redundant to see "Dose 1" on all of the table columns. This is DISTINCT from PK parameters that are specifically for user-defined AUC intervals. See column "UserInterval".

Sheet

the sheet in a simulator output file where the PK parameter will be extracted, if possible

AppliesToSingleDose

TRUE or FALSE for whether this item applies only to single-dose data

SearchText

Regex to use for finding the parameter

AUCtab_StartColText

For the older AUC tabs, you had to look at one row above the main row to figure out which sets of PK values were for baseline, which were for the DDI, which were in plasma, which were in blood, etc., so this addresses at least the DDI part of the question.

AppliesToSingleDose

TRUE or FALSE for whether this applies to scenarios where only a single dose was administered. Note that all UserInterval parameters have this set to true b/c you could conceivably have a situation where someone had a user-defined interval that was shorter than the full simulation.

AppliesOnlyWhenPerpPresent

TRUE or FALSE for whether this item only applies when a perpetrator is present in the simulation

UserInterval

Applies specifically to user-defined interval data

SwitchWhenInhib

Sometimes, the regex changes from what is used for the substrate when the compound of interest is a perpetrator. This notes what the regex changes to in that situation.

SortOrder

the order to arrange columns for pk_table

PrettifiedNames

Pretty names to use in tables, etc.

PrettifiedNames_nodosenum

Pretty names to use in tables, etc., when the user doesn't want the dose number included.

Notes

an explanation of what the parameter is

shirewoman2/Consultancy documentation built on Feb. 18, 2025, 10 p.m.