Skip to contents

This function returns a pmart object that has been undergone TIGER batch effect correction

Usage

bc_tiger(
  omicsData,
  sampletype_cname,
  test_val,
  group_cname,
  position_cname = NULL,
  injection_cname = NULL
)

Arguments

omicsData

an object of the class 'pepData', 'proData', 'metabData', 'lipidData', or 'nmrData', usually created by as.pepData, as.proData, as.metabData, as.lipidData, or as.nmrData, respectively.

sampletype_cname

character string giving the name of the column in omicsData$f_data that contains the sample type information (such as quality control samples)

test_val

character string giving the name of the value within the column sampletype_cname to be used as the testing value for TIGER

group_cname

character string giving the name of the column in omicsData$f_data that contians the group information

position_cname

character string giving the name of the column in omicsData$f_data that contains the well position, default is NULL

injection_cname

character string giving the name of the column in omicsData$f_data that contains the injection order, default is NULL

Value

Object of same class as omicsData that has been undergone TIGER normalization

Author

Damon Leach

Examples

library(malbacR)
library(pmartR)
data("pmart_amide")
pmart_amide <- group_designation(pmart_amide,main_effects = "group",batch_id = "batch")
tigerFilt <- tiger_filter(pmart_amide,sampletype_cname = "group",test_val = "QC")
pmart_amideFilt <- apply_tigerFilt(tigerFilt,pmart_amide)
#> There are no molecules that need to be removed. Returning the original omicsData
amide_tiger <- bc_tiger(omicsData = pmart_amideFilt,sampletype_cname = "group",
                        test_val = "QC",injection_cname = "Injection_order",group_cname = "group")
#> + Initialising...   2024-02-06 12:20:01
#> + Computing target values...   2024-02-06 12:20:01
#> + Selecting highly-correlated variables...   2024-02-06 12:20:01
#>   - Computing correlation coefficients...
#>   - Selecting variables...
#> + Data correction started.   2024-02-06 12:20:02
#> 
  |                                                                      | 0 % ~calculating  
  |==                                                                    | 2 % ~06m 30s      
  |===                                                                   | 4 % ~04m 49s      
  |====                                                                  | 5 % ~04m 08s      
  |=====                                                                 | 7 % ~03m 46s      
  |=======                                                               | 9 % ~03m 31s      
  |========                                                              | 11% ~03m 20s      
  |=========                                                             | 12% ~03m 13s      
  |==========                                                            | 14% ~03m 06s      
  |============                                                          | 16% ~03m 00s      
  |=============                                                         | 18% ~02m 55s      
  |==============                                                        | 20% ~02m 49s      
  |===============                                                       | 21% ~02m 45s      
  |=================                                                     | 23% ~02m 41s      
  |==================                                                    | 25% ~02m 36s      
  |===================                                                   | 27% ~02m 31s      
  |====================                                                  | 29% ~02m 27s      
  |======================                                                | 30% ~02m 23s      
  |=======================                                               | 32% ~02m 19s      
  |========================                                              | 34% ~02m 15s      
  |=========================                                             | 36% ~02m 11s      
  |===========================                                           | 38% ~02m 07s      
  |============================                                          | 39% ~02m 03s      
  |=============================                                         | 41% ~01m 59s      
  |==============================                                        | 43% ~01m 55s      
  |================================                                      | 45% ~01m 51s      
  |=================================                                     | 46% ~01m 47s      
  |==================================                                    | 48% ~01m 43s      
  |===================================                                   | 50% ~01m 39s      
  |=====================================                                 | 52% ~01m 35s      
  |======================================                                | 54% ~01m 32s      
  |=======================================                               | 55% ~01m 28s      
  |========================================                              | 57% ~01m 24s      
  |==========================================                            | 59% ~01m 21s      
  |===========================================                           | 61% ~01m 17s      
  |============================================                          | 62% ~01m 14s      
  |=============================================                         | 64% ~01m 10s      
  |===============================================                       | 66% ~01m 07s      
  |================================================                      | 68% ~01m 03s      
  |=================================================                     | 70% ~59s          
  |==================================================                    | 71% ~56s          
  |====================================================                  | 73% ~52s          
  |=====================================================                 | 75% ~49s          
  |======================================================                | 77% ~45s          
  |=======================================================               | 79% ~42s          
  |=========================================================             | 80% ~38s          
  |==========================================================            | 82% ~35s          
  |===========================================================           | 84% ~31s          
  |============================================================          | 86% ~28s          
  |==============================================================        | 88% ~24s          
  |===============================================================       | 89% ~21s          
  |================================================================      | 91% ~17s          
  |=================================================================     | 93% ~14s          
  |===================================================================   | 95% ~10s          
  |====================================================================  | 96% ~07s          
  |===================================================================== | 98% ~03s          
  |======================================================================| 100% elapsed=03m 12s
#>   - Merging results...
#> + Completed.   2024-02-06 12:23:17