This function lists the observations and lines that were excluded from the analysis of a PKanalix or Monolix project, returning them as rows from the original dataset. Three sources of exclusion are listed with this helper:
-
observations removed by an
ignore observationtag, -
lines removed by an
ignore linetag (including a 0/1 ignore column where a value of1drops the line), -
data removed through the filter module.
Every column of the original dataset is reflected in the output, regardless of whether a given row was tagged as ignored, so the full record of each excluded line is available.
Usage
listingExclusions(projectFile = NULL,
mock = FALSE)
Arguments
-
projectFile(character): Path to a PKanalix (.pkx) or Monolix (.mlxtran) project file, orNULLto use the currently loaded project. -
mock(logical): WhenTRUE, masks the listing for documentation and example outputs, by column data type (fromgetData()): id becomes"id1", observation id becomes"obsid1", categorical covariates become"Category 1", occasions become"occ1", dates become"xx/xx/xxxx", and all numeric columns (times, observations, continuous covariates, ...) become"xx.xx". Untagged columns (those with no header type) are also masked as"xx.xx". Missing markers (".") are kept. DefaultFALSE.
Examples
Listing of exclusions based on a project without filters
prj1 <- c("path/to/project/prj01_Exclusions.pkx")
loadProject(projectFile = prj1)
#> 11 lines were filtered in pkanalix
#> STUDYID SUBJID VISIT_OCC TIME AMT AVALC MDV DOSE FOOD VISIT PCLLOQ Exclusion_reason
#> 11325 1 1 11.1 . 0.123646 1 20mg Standard Breakfast DAY 1 0.05 1 Sample collected outside the protocol-defined window
#> 11325 1 2 12.0 . 1.0884024 1 20mg Fasted DAY 7 0.05 2 Documented bioanalytical or laboratory issue
#> 11325 1 3 17.1 . 0.0809957 1 20mg Standard Breakfast DAY 14 0.05 1 Sample collected outside the protocol-defined window
#> 11325 2 2 12.0 . 0.0684246 1 20mg Fasted DAY 7 0.05 3 Documented sample handling or processing issue
#> 11325 3 3 18.0 . 0.0601321 1 20mg Standard Breakfast DAY 14 0.05 2 Documented bioanalytical or laboratory issue
#> 11325 4 1 18.0 . 0.0588139 1 20mg Standard Breakfast DAY 1 0.05 3 Documented sample handling or processing issue
#> 11325 6 1 12.0 . 0.0523899 1 20mg Standard Breakfast DAY 1 0.05 3 Documented sample handling or processing issue
#> 11325 7 3 12.0 . 0.073043 1 20mg Standard Breakfast DAY 14 0.05 2 Documented bioanalytical or laboratory issue
#> 11325 15 1 18.0 . 0.0548464 1 80mg Standard Breakfast DAY 1 0.05 4 PK-inconsistent isolated value suggesting sample mix-up
#> 11325 17 2 18.0 . 0.0648885 1 120mg Fasted DAY 7 0.05 4 PK-inconsistent isolated value suggesting sample mix-up
#> 11325 23 1 23.9 . 0.0519735 1 120mg Standard Breakfast DAY 1 0.05 1 Sample collected outside the protocol-defined window
Listing of exclusions based on a project with filters
prj2 <- c("path/to/project/prj02_ExclusionsAndFilters.pkx")
head(listingExclusions(projectFile = prj2), 10)
#> 272 lines were filtered in pkanalix
#> STUDYID SUBJID VISIT_OCC TIME AMT AVALC MDV DOSE FOOD VISIT PCLLOQ Exclusion_reason
#> 11325 1 1 11.1 . 0.123646 1 20mg Standard Breakfast DAY 1 0.05 1 Sample collected outside the protocol-defined window
#> 11325 1 2 12.0 . 1.0884024 1 20mg Fasted DAY 7 0.05 2 Documented bioanalytical or laboratory issue
#> 11325 1 3 0.0 20 . 0 20mg Standard Breakfast DAY 14 0.05 <NA>
#> 11325 1 3 0.0 . . 0 20mg Standard Breakfast DAY 14 0.05 <NA>
#> 11325 1 3 0.5 . 0.434084 0 20mg Standard Breakfast DAY 14 0.05 <NA>
#> 11325 1 3 1.0 . 2.38916 0 20mg Standard Breakfast DAY 14 0.05 <NA>
#> 11325 1 3 2.0 . 2.28361 0 20mg Standard Breakfast DAY 14 0.05 <NA>
#> 11325 1 3 3.0 . 2.00695 0 20mg Standard Breakfast DAY 14 0.05 <NA>
#> 11325 1 3 4.0 . 0.908206 0 20mg Standard Breakfast DAY 14 0.05 <NA>
#> 11325 1 3 6.0 . 1.00559 0 20mg Standard Breakfast DAY 14 0.05 <NA>
Listing of exclusions based (mocked data)
prj1 <- c("path/to/project/prj01_Exclusions.pkx")
listingExclusions(projectFile = prj1,
mock = TRUE)
#> 11 lines were filtered in pkanalix
#> STUDYID SUBJID VISIT_OCC TIME AMT AVALC MDV DOSE FOOD VISIT PCLLOQ Exclusion_reason
#> Category 1 id1 occ1 xx.xx . xx.xx xx.xx Category 1 Category 1 Category 1 xx.xx xx.xx
#> Category 1 id1 occ2 xx.xx . xx.xx xx.xx Category 1 Category 2 Category 2 xx.xx xx.xx
#> Category 1 id1 occ3 xx.xx . xx.xx xx.xx Category 1 Category 1 Category 3 xx.xx xx.xx
#> Category 1 id2 occ2 xx.xx . xx.xx xx.xx Category 1 Category 2 Category 2 xx.xx xx.xx
#> Category 1 id3 occ3 xx.xx . xx.xx xx.xx Category 1 Category 1 Category 3 xx.xx xx.xx
#> Category 1 id4 occ1 xx.xx . xx.xx xx.xx Category 1 Category 1 Category 1 xx.xx xx.xx
#> Category 1 id5 occ1 xx.xx . xx.xx xx.xx Category 1 Category 1 Category 1 xx.xx xx.xx
#> Category 1 id6 occ3 xx.xx . xx.xx xx.xx Category 1 Category 1 Category 3 xx.xx xx.xx
#> Category 1 id7 occ1 xx.xx . xx.xx xx.xx Category 2 Category 1 Category 1 xx.xx xx.xx
#> Category 1 id8 occ2 xx.xx . xx.xx xx.xx Category 3 Category 2 Category 2 xx.xx xx.xx
#> Category 1 id9 occ1 xx.xx . xx.xx xx.xx Category 3 Category 1 Category 1 xx.xx xx.xx