Add column rename information to st object

See the cols_rename argument passed to stable() and then tab_cols(). This function can be called multiple times and will accumulate cols_rename data.

Usage

st_rename(x, ..., .list = NULL)

Arguments

x

an stobject

...

column rename items in new-name = old-name format; passed to stable() as cols_rename

.list

a named list of rename data with the format old-name = new-name; this specification is similar passing items via ..., but note that rename specification is reversed. The intended use for this argument is to utilize list output from the yspec package which takes the form column-name = short-name (e.g. WT = weight for the WT column).

Examples

library(dplyr)

st_new(stdata()) %>% st_rename(weight = WT) %>% stable()
#>  [1] "\\setlength{\\tabcolsep}{5pt} "                                             
#>  [2] "\\begin{threeparttable}"                                                    
#>  [3] "\\renewcommand{\\arraystretch}{1.3}"                                        
#>  [4] "\\begin{tabular}[h]{lllllllll}"                                             
#>  [5] "\\hline"                                                                    
#>  [6] "STUDY & DOSE & FORM & N & weight & CRCL & AGE & ALB & SCR \\\\"             
#>  [7] "\\hline"                                                                    
#>  [8] "12-DEMO-001 & 100 mg & tablet & 80 & 71.4 & 104 & 33.7 & 4.20 & 1.06 \\\\"  
#>  [9] "12-DEMO-001 & 150 mg & capsule & 16 & 89.4 & 122 & 24.4 & 4.63 & 1.12 \\\\" 
#> [10] "12-DEMO-001 & 150 mg & tablet & 48 & 81.7 & 104 & 34.4 & 3.83 & 0.910 \\\\" 
#> [11] "12-DEMO-001 & 150 mg & troche & 16 & 94.0 & 93.2 & 27.4 & 4.94 & 1.25 \\\\" 
#> [12] "12-DEMO-001 & 200 mg & tablet & 64 & 67.9 & 100 & 27.5 & 4.25 & 1.10 \\\\"  
#> [13] "12-DEMO-001 & 200 mg & troche & 16 & 76.6 & 99.2 & 22.8 & 4.54 & 1.15 \\\\" 
#> [14] "12-DEMO-002 & 100 mg & capsule & 36 & 61.3 & 113 & 38.3 & 4.04 & 1.28 \\\\" 
#> [15] "12-DEMO-002 & 100 mg & tablet & 324 & 77.6 & 106 & 29.9 & 4.31 & 0.981 \\\\"
#> [16] "12-DEMO-002 & 50 mg & capsule & 36 & 74.1 & 112 & 37.1 & 4.44 & 0.900 \\\\" 
#> [17] "12-DEMO-002 & 50 mg & tablet & 324 & 71.2 & 106 & 34.1 & 4.63 & 0.868 \\\\" 
#> [18] "12-DEMO-002 & 75 mg & capsule & 36 & 72.4 & 105 & 38.2 & 3.89 & 0.900 \\\\" 
#> [19] "12-DEMO-002 & 75 mg & tablet & 288 & 71.6 & 98.9 & 34.2 & 4.49 & 0.991 \\\\"
#> [20] "12-DEMO-002 & 75 mg & troche & 36 & 73.6 & 103 & 49.2 & 4.52 & 0.930 \\\\"  
#> [21] "\\hline"                                                                    
#> [22] "\\end{tabular}"                                                             
#> [23] "\\end{threeparttable}"                                                      
#> attr(,"class")
#> [1] "stable"

st_new(stdata()) %>% st_rename(.list = list(WT = "weight")) %>% stable()
#>  [1] "\\setlength{\\tabcolsep}{5pt} "                                             
#>  [2] "\\begin{threeparttable}"                                                    
#>  [3] "\\renewcommand{\\arraystretch}{1.3}"                                        
#>  [4] "\\begin{tabular}[h]{lllllllll}"                                             
#>  [5] "\\hline"                                                                    
#>  [6] "STUDY & DOSE & FORM & N & weight & CRCL & AGE & ALB & SCR \\\\"             
#>  [7] "\\hline"                                                                    
#>  [8] "12-DEMO-001 & 100 mg & tablet & 80 & 71.4 & 104 & 33.7 & 4.20 & 1.06 \\\\"  
#>  [9] "12-DEMO-001 & 150 mg & capsule & 16 & 89.4 & 122 & 24.4 & 4.63 & 1.12 \\\\" 
#> [10] "12-DEMO-001 & 150 mg & tablet & 48 & 81.7 & 104 & 34.4 & 3.83 & 0.910 \\\\" 
#> [11] "12-DEMO-001 & 150 mg & troche & 16 & 94.0 & 93.2 & 27.4 & 4.94 & 1.25 \\\\" 
#> [12] "12-DEMO-001 & 200 mg & tablet & 64 & 67.9 & 100 & 27.5 & 4.25 & 1.10 \\\\"  
#> [13] "12-DEMO-001 & 200 mg & troche & 16 & 76.6 & 99.2 & 22.8 & 4.54 & 1.15 \\\\" 
#> [14] "12-DEMO-002 & 100 mg & capsule & 36 & 61.3 & 113 & 38.3 & 4.04 & 1.28 \\\\" 
#> [15] "12-DEMO-002 & 100 mg & tablet & 324 & 77.6 & 106 & 29.9 & 4.31 & 0.981 \\\\"
#> [16] "12-DEMO-002 & 50 mg & capsule & 36 & 74.1 & 112 & 37.1 & 4.44 & 0.900 \\\\" 
#> [17] "12-DEMO-002 & 50 mg & tablet & 324 & 71.2 & 106 & 34.1 & 4.63 & 0.868 \\\\" 
#> [18] "12-DEMO-002 & 75 mg & capsule & 36 & 72.4 & 105 & 38.2 & 3.89 & 0.900 \\\\" 
#> [19] "12-DEMO-002 & 75 mg & tablet & 288 & 71.6 & 98.9 & 34.2 & 4.49 & 0.991 \\\\"
#> [20] "12-DEMO-002 & 75 mg & troche & 36 & 73.6 & 103 & 49.2 & 4.52 & 0.930 \\\\"  
#> [21] "\\hline"                                                                    
#> [22] "\\end{tabular}"                                                             
#> [23] "\\end{threeparttable}"                                                      
#> attr(,"class")
#> [1] "stable"