Position the table's caption

Source: R/properties-table.R

If caption_pos is "top" or "bottom", then the horizontal position ("left", "center" or "right") will be determined by the huxtable"s position().

caption_pos(ht)
caption_pos(ht) <- value
set_caption_pos(ht, value)

Arguments

ht

A huxtable.

value

String: "top", "bottom", "topleft", "topcenter", "topright", "bottomleft", "bottomcenter" or "bottomright". Set to NA to reset to the default, which is "top".

Value

caption_pos() returns the caption_pos property. set_caption_pos() returns the modified huxtable.

See also

Other caption properties: caption(), caption_width()

Examples


caption_pos(jams) <-  "topleft"
caption_pos(jams)
#> [1] "topleft"

caption(jams) <- "Jam for sale"
jams
#>                        Jam for sale                                             
#>                        Type         Price   Sugar content  
#>                        Strawberry    1.90          40.00%  
#>                        Raspberry     2.10          35.00%  
#>                        Plum          1.80          50.00%  
#> 
#> Column names: Type, Price, Sugar
set_caption_pos(jams, "bottom")
#>                        Type         Price   Sugar content  
#>                        Strawberry    1.90          40.00%  
#>                        Raspberry     2.10          35.00%  
#>                        Plum          1.80          50.00%  
#>                                   Jam for sale                                  
#> 
#> Column names: Type, Price, Sugar