R: Caption position

caption_pos {huxtable} | R Documentation

## Caption position

### Description

Functions to get or set the table-level caption position property of a huxtable.

### Usage

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

### Arguments

`ht` | A huxtable.
`value` | A length-one character vector, one of 'top', 'bottom', 'topleft', 'topcenter', 'topright', 'bottomleft', 'bottomcenter', 'bottomright'. Set to `NA` to reset to the default, which is `"top"`.

### Details

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

### Value

For `caption_pos`, the `caption_pos` property. For `set_caption_pos`, the `ht` object.

### See Also

`caption()`

### Examples

    ht <- huxtable(a = 1:3, b = 1:3)
    caption_pos(ht) <-  'bottom'
    caption_pos(ht)

[Package huxtable version 4.2.0 Index]