Add column or row names

Source: R/dimnames.R

Add a first row of column names, or a first column of row names, to the huxtable.

add_colnames(ht, ...)

# S3 method for huxtable
add_colnames(ht, rowname = NULL, ...)

add_rownames(ht, ...)

# S3 method for huxtable
add_rownames(ht, colname = "rownames", preserve_rownames = TRUE, ...)

Arguments

ht

A huxtable.
...

Arguments passed to methods.
rowname

Optional row name for the new row of column names.
colname

Column name for the new column of row names.
preserve_rownames

Preserve existing row names.

Value

The modified object.

Details

Note that add_colnames will change the mode of all columns to character. Also note that it will move your rows down by one: what was row 1 will now be row 2, and the column names will now be row 1.

add_colnames preserves column names. add_rownames only preserves them if asked to.

Examples

ht <- huxtable(
        First  = rnorm(5),
        Second = rnorm(5)
      )
add_rownames(ht)
#>                            1          First   Second  
#>                            1.1     -1.4        1.15   
#>                            2        0.255     -1.82   
#>                            3       -2.44      -0.247  
#>                            4       -0.00557   -0.244  
#>                            5        0.622     -0.283  
#> 
#> Column names: rownames, First, Second
add_colnames(ht)
#>                                First      Second   
#>                                   First    Second  
#>                                -1.4         1.15   
#>                                 0.255      -1.82   
#>                                -2.44       -0.247  
#>                                -0.00557    -0.244  
#>                                 0.622      -0.283  
#> 
#> Column names: First, Second

# Out by 1:
add_rownames(add_colnames(ht))
#>                            1       First      Second  
#>                            1.2        First   Second  
#>                            1.1     -1.4        1.15   
#>                            2        0.255     -1.82   
#>                            3       -2.44      -0.247  
#>                            4       -0.00557   -0.244  
#>                            5        0.622     -0.283  
#> 
#> Column names: rownames, First, Second

# Better:
add_colnames(add_rownames(ht))
#>                           rownames   First      Second  
#>                           1             First   Second  
#>                           1.1        -1.4        1.15   
#>                           2           0.255     -1.82   
#>                           3          -2.44      -0.247  
#>                           4          -0.00557   -0.244  
#>                           5           0.622     -0.283  
#> 
#> Column names: rownames, First, Second

# Alternatively:
add_colnames(add_rownames(ht, ""))
#>                                    First      Second  
#>                            1          First   Second  
#>                            1.1     -1.4        1.15   
#>                            2        0.255     -1.82   
#>                            3       -2.44      -0.247  
#>                            4       -0.00557   -0.244  
#>                            5        0.622     -0.283  
#> 
#> Column names: , First, Second